Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jolpica/jolpica-f1
https://github.com/jolpica/jolpica-f1
Last synced: 2 days ago
JSON representation
- Host: GitHub
- URL: https://github.com/jolpica/jolpica-f1
- Owner: jolpica
- License: apache-2.0
- Created: 2023-10-01T16:09:59.000Z (about 1 year ago)
- Default Branch: main
- Last Pushed: 2024-12-05T23:26:33.000Z (16 days ago)
- Last Synced: 2024-12-13T23:56:44.222Z (8 days ago)
- Language: Python
- Size: 27.8 MB
- Stars: 173
- Watchers: 9
- Forks: 11
- Open Issues: 19
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
- starred - jolpica/jolpica-f1 - (Python)
README
# jolpica-f1
API for querying formula one data, with backwards compatible endpoints for the soon to be deprecated ergast api.
The Ergast compatible API can be found here: http://api.jolpi.ca/ergast/f1/
# Documentation
Our documentation can be [found here](/docs/README.md).
### Ergast Differences
If you are migrating from the ergast api, please check the known differences [here](/docs/ergast_differences.md).
# Database Scheme
Rather than import the existing database scheme used by ergast, we use a new scheme which will allow better adaption to changing rulesets, reduce duplication of information, and allow storage of more F1 related data.
Many Enumerations are used in the database, the mappings of these values are defined in their respective model files. For example you can find the enumerations for the PointSystem table [here](jolpica/formula_one/models/point_scheme.py)
# Development
## Initial Setup
### Prerequisite
Use of the devcontainer is recommended. If not using, look at `.devcontainer/Dockerfile` for required installs.
Current requirements are:
- Poetry for python
- [Geo Libraries for postgis and geodjango](https://docs.djangoproject.com/en/4.2/ref/contrib/gis/install/geolibs/#geosbuild)
- A postgres database which can be accessed via the `DATABASE_SECRET_URL` environment variable.
### Data Import
- If not using the devcontainer, Install python dependencies `poetry install`, and activate the venv `poetry shell`
- Run any initial setup for development
```
make setup
```
- Create all required database tables
```
python manage.py migrate
```
- Download csv data from ergast and import into postgres database
```
make load-ergast-data
```
- Convert data to new schema, then run & create the test database
```
make import-from-ergast
pytest --create-db
```
This will fill the database with the latest data from ergast, and create the initial test database so all future tests will run quicker.
## Running the Server
To run the server
```make run```
This will start jolpica-f1 on port 8000. Once it is running you can access the API via browser, curl or any other tools with `http://localhost:8000/ergast/f1/`. Any changes made to the source code will be automatically updated, while it is running.
## Running Tests
The first time the tests are run it will take upto 2 minutes to populate the database with test data, pytest is configured to reuse this database on future runs, so tests should run much faster on future runs.
To run tests after a migration change you must run with the `--create-db` flag to ensure it uses the new migrations.
To run the tests
```pytest```
## Reporting Bugs / Contributing
For information on contributing to this project please read the [contributing guidelines](CONTRIBUTING.md).