Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/cybercoder-naj/debriefserver
Flask app to serve F1 season and Race details along with images comparing driver lap times and more.
https://github.com/cybercoder-naj/debriefserver
f1 flask formula1 python rest-api server
Last synced: 8 days ago
JSON representation
Flask app to serve F1 season and Race details along with images comparing driver lap times and more.
- Host: GitHub
- URL: https://github.com/cybercoder-naj/debriefserver
- Owner: cybercoder-naj
- License: mit
- Created: 2023-05-24T16:30:37.000Z (over 1 year ago)
- Default Branch: main
- Last Pushed: 2023-08-03T14:17:25.000Z (over 1 year ago)
- Last Synced: 2024-10-27T12:11:45.514Z (about 2 months ago)
- Topics: f1, flask, formula1, python, rest-api, server
- Language: Python
- Homepage:
- Size: 299 KB
- Stars: 0
- Watchers: 2
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- Contributing: contributing.md
- License: LICENSE
Awesome Lists containing this project
README
# Debrief Server
Flask app to serve F1 season and Race details along with images comparing driver lap times and more.
Some responses will be taken directly from [Ergast](http://ergast.com/mrd/), while the images with telemetry
data will be processed from the [FastF1](https://docs.fastf1.dev/index.html) python library.
## Screenshots
## API Reference
#### Get Race Schedule
```http
GET /race-schedule/
```
| Parameter | Type | Description |
|:----------|:------|:--------------------------------------------|
| `year` | `int` | Year for desired race schedule. |
#### Get Line Graph Image for Fastest Laps
```http
GET /fastest-laps/line-graph
```
| Parameter | Type | Description |
|:----------|:------------|:--------------------------------------------------------------------------------------------|
| `x` | `string` | Field for x-axis: `Speed`, `RPM`, `nGear`, `Throttle`, `Brake`, `DRS`, `Distance`, `Time`. |
| `y` | `string` | Field for y-axis: `Speed`, `RPM`, `nGear`, `Throttle`, `Brake`, `DRS`, `Distance`, `Time`. |
| `gp` | `string` | Name of the circuit. |
| `year` | `int` | Year of the F1 Season. |
| `drivers` | `list[str]` | Comma-separated(,) list of drivers to compare. Use driver code in block letters |
## Contributing
Contributions are always welcome!
See [`contributing.md`](contributing.md) for ways to get started.
## License
[MIT](LICENSE)
## Authors
- [@cybercoder-naj](https://www.github.com/cybercoder-naj)