https://github.com/dvrpc/crash-api
API and data import for DVRPC's crash data.
https://github.com/dvrpc/crash-api
Last synced: 5 months ago
JSON representation
API and data import for DVRPC's crash data.
- Host: GitHub
- URL: https://github.com/dvrpc/crash-api
- Owner: dvrpc
- Created: 2021-03-25T17:43:44.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-09-17T20:25:56.000Z (9 months ago)
- Last Synced: 2025-10-13T22:22:39.373Z (8 months ago)
- Language: Python
- Homepage: https://cloud.dvrpc.org/api/crash-data/v1/docs
- Size: 4.32 MB
- Stars: 0
- Watchers: 4
- Forks: 0
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# Crash API
API and data import for DVRPC's crash data.
Front end repo is at https://github.com/dvrpc/crash-data-tool.
See the [API](api/README.md) and [Data](data/README.md) READMEs for additional information.
Note: the API will be automatically redeployed upon a successful pull request merge via a Webhook (in conjunction with the [automated deployments API](https://github.com/dvrpc/automated-deployments-api) and the [cloud-ansible](https://github.com/dvrpc/cloud-ansible) project, with results emailed to those monitoring such activities.
## Virtual environment
A Python virtual environment is required for the API, the data import, and the tests. Create it in the project root (this top-level directory) and install the requirements:
```bash
python3 -m venv ve
. ve/bin/activate
pip install -r requirements.txt
```
## Tests
The tests check both the database accuracy as well as the API functionality. Therefore, before running tests, follow the instructions in data/README.md to set up and populate a database.
Then, within a virtual environment and from the project root, run `python -m pytest`. All tests in the tests/ directory will be executed.