Ecosyste.ms: Awesome

An open API service indexing awesome lists of open source software.
Awesome Lists | Featured Topics | Projects
https://github.com/f1db/f1db

Open Source Formula 1 Database
https://github.com/f1db/f1db
csv database db f1 f1db formula1 json mysql opendata postgesql smile sql sqlite
Last synced: 4 days ago
JSON representation
Open Source Formula 1 Database
Host: GitHub
URL: https://github.com/f1db/f1db
Owner: f1db
License: cc-by-4.0
Created: 2021-09-07T11:36:08.000Z (over 3 years ago)
Default Branch: main
Last Pushed: 2024-10-22T07:32:24.000Z (2 months ago)
Last Synced: 2024-10-23T10:47:54.212Z (2 months ago)
Topics: csv, database, db, f1, f1db, formula1, json, mysql, opendata, postgesql, smile, sql, sqlite
Language: Kotlin
Homepage:
Size: 7.84 MB
Stars: 192
Watchers: 10
Forks: 22
Open Issues: 5
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project

README

        [![GitHub Release](https://img.shields.io/github/v/release/f1db/f1db?style=for-the-badge&labelColor=%23333&color=%23d40000&)](https://github.com/f1db/f1db/releases)

[![GitHub License](https://img.shields.io/github/license/f1db/f1db?style=for-the-badge&labelColor=%23333&color=%23d40000)](https://creativecommons.org/licenses/by/4.0/)

[![GitHub Downloads (all assets, all releases)](https://img.shields.io/github/downloads/f1db/f1db/total?style=for-the-badge&labelColor=%23333&color=%23d40000)](https://github.com/f1db/f1db/releases)

[![GitHub Repo stars](https://img.shields.io/github/stars/f1db/f1db?style=for-the-badge&labelColor=%23333&color=%23d40000)](https://github.com/f1db/f1db/stargazers)

## F1DB

[F1DB] is the most comprehensive free open source database with all-time Formula 1 racing data and statistics.

Whether you are building a custom website, mobile application or just using F1DB to query data, here is what we provide:

- All drivers

- All constructors (including chassis)

- All engine manufacturers (including engines)

- All tyre manufacturers

- All circuits and location data

- All seasons from 1950 to present; including:

  - entrants

  - standings

- All races; including:

  - free practice and warming-up results

  - qualifying and pre-qualifying results

  - sprint race results

  - starting grid positions

  - race results

  - fastest laps

  - pit stops

  - driver of the day results

  - standings

New releases will be available as soon as possible after every race. See also [Versioning](#versioning).

Release artifacts are available in the following formats:

- CSV

- JSON

- JSON splitted (multiple data files)

- Smile (binary variant of the JSON format)

- SQL (MySQL, PostgreSQL or SQLite .sql dump files to create and populate a custom database)

- SQLite database

## Notable and Breaking Changes in `v2024.19.0`

- Added chassis and engine data.

- Added qualification position details (`qualificationPositionNumber` and `qualificationPositionText`) to race results and starting grid positions.

- Added total points statistic (`totalPoints`) to constructors and engine manufacturers.

- Added extensive season statistics for drivers, constructors, engine manufacturers and tyre manufacturers.

- Renamed `ConstructorPreviousNextConstructor` to `ConstructorChronology`

- Added explicit `positionDisplayOrder` to `DriverFamilyRelationship`, `ConstructorChronology`, `PracticeResult`, `QualifyingResult`, `StartingGridPosition`, `RaceResult`, `FastestLap`, `PitStop`, `DriverOfTheDayResult`, `RaceDriverStanding`, `RaceConstructorStanding`, `SeasonDriverStanding` and `SeasonConstructorStanding`.

To accommodate these (breaking) changes the JSON Schema is bumped to version `v5.0.0`.

## F1DB JSON Schema

The main [`f1db.schema.json`](https://raw.githubusercontent.com/f1db/f1db/main/src/schema/current/single/f1db.schema.json)

schema file contains all F1DB object definitions and serves as the main documentation.  

For the splitted distributions the [splitted](https://github.com/f1db/f1db/tree/main/src/schema/current/splitted)

schema files must be used.

Both the JSON and Smile artifacts validate against the F1DB Json Schema.

#### Schema version compatibility / history

| Version                 | Schema Version                                                                                                                                                                                                                                    |

|-------------------------|---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------|

| `>=` `v2024.19.0`       | [`f1db.schema.json v5.0.0`](https://raw.githubusercontent.com/f1db/f1db/main/src/schema/v5.0.0/single/f1db.schema.json), [`f1db-*.schema.json v5.0.0 splitted`](https://github.com/f1db/f1db/tree/main/src/schema/v5.0.0/splitted)                |

| `>=` `v2024.0.0.beta2`  | [`f1db.schema.json v4.1.0`](https://raw.githubusercontent.com/f1db/f1db/main/src/schema/v4.1.0/single/f1db.schema.json), [`f1db-*.schema.json v4.1.0 splitted`](https://github.com/f1db/f1db/tree/main/src/schema/v4.1.0/splitted)                |

| `>=` `v2024.0.0.beta1`  | [`f1db.schema.json v4.0.0`](https://raw.githubusercontent.com/f1db/f1db/main/src/schema/v4.0.0/single/f1db.schema.json), [`f1db-*.schema.json v4.0.0 splitted`](https://github.com/f1db/f1db/tree/main/src/schema/v4.0.0/splitted)                |

| `>=` `v2023.22.0`       | [`onlyf1-db.schema.json v3.2.0`](https://raw.githubusercontent.com/f1db/f1db/main/src/schema/v3.2.0/single/onlyf1-db.schema.json), [`onlyf1-db-*.schema.json v3.2.0 splitted`](https://github.com/f1db/f1db/tree/main/src/schema/v3.2.0/splitted) |

| `>=` `v2023.8.0`        | [`onlyf1-db.schema.json v3.1.0`](https://raw.githubusercontent.com/f1db/f1db/main/src/schema/v3.1.0/single/onlyf1-db.schema.json), [`onlyf1-db-*.schema.json v3.1.0 splitted`](https://github.com/f1db/f1db/tree/main/src/schema/v3.1.0/splitted) |

| `>=` `v2023.4.0`        | [`onlyf1-db.schema.json v3.0.0`](https://raw.githubusercontent.com/f1db/f1db/main/src/schema/v3.0.0/single/onlyf1-db.schema.json), [`onlyf1-db-*.schema.json v3.0.0 splitted`](https://github.com/f1db/f1db/tree/main/src/schema/v3.0.0/splitted) |

| `>=` `v2023.0.0.beta1`  | [`onlyf1-db.schema.json v2.0.0`](https://raw.githubusercontent.com/f1db/f1db/main/src/schema/v2.0.0/single/onlyf1-db.schema.json), [`onlyf1-db-*.schema.json v2.0.0 splitted`](https://github.com/f1db/f1db/tree/main/src/schema/v2.0.0/splitted) |

| `>=` `v2022.1.1`        | [`f1db-json-schema-v1.4.0.json`](https://raw.githubusercontent.com/f1db/f1db/main/src/schema/v1.x/f1db-json-schema-v1.4.0.json)                                                                                                                   |

| `>=` `v2022.0.0`        | [`f1db-json-schema-v1.3.0.json`](https://raw.githubusercontent.com/f1db/f1db/main/src/schema/v1.x/f1db-json-schema-v1.3.0.json)                                                                                                                   |

| `>=` `v2022.0.0.beta4`  | [`f1db-json-schema-v1.3.0.json`](https://raw.githubusercontent.com/f1db/f1db/main/src/schema/v1.x/f1db-json-schema-v1.3.0.json)                                                                                                                   |

| `>=` `v2022.0.0.beta3`  | [`f1db-json-schema-v1.2.0.json`](https://raw.githubusercontent.com/f1db/f1db/main/src/schema/v1.x/f1db-json-schema-v1.2.0.json)                                                                                                                   |

| `>=` `v2022.0.0.beta2`  | [`f1db-json-schema-v1.1.0.json`](https://raw.githubusercontent.com/f1db/f1db/main/src/schema/v1.x/f1db-json-schema-v1.1.0.json)                                                                                                                   |

| `>=` `v2022.0.0.alpha1` | [`f1db-json-schema-v1.0.0.json`](https://raw.githubusercontent.com/f1db/f1db/main/src/schema/v1.x/f1db-json-schema-v1.0.0.json)                                                                                                                   |

## F1DB SQL / SQLite Database

The SQLite database artifact contains all data in a relational database format

and can be used to directly query the data instead of processing the JSON format.

The database file could also serve students who want to learn SQL.

We suggest to use [SQLiteStudio] for querying the database file.

Of course any SQLite compliant SQL client can be used as well.

Since `v2024.3.0` SQL artifacts are available for MySQL, PostgreSQL and SQLite

that provide .sql dump files to import the schema and data directly in these database systems.

If you want to populate another database system (e.g. H2) then most likely the

PostgreSQL .sql dump file is your best option. 

If that doesn't work, and you want a .sql dump file for another database system to be added

to the release artifacts, then please create a [feature request](https://github.com/f1db/f1db/issues).

## Versioning

Releases are versioned using a "customized" [CalVer] versioning scheme:

    YYYY.RR.MICRO(.MODIFIER)

which uses the following conventions:

- **YYYY** – Full year of the season – `2024`, ..

- **RR** – Round number within the season – `0`, `1`, `2`, .., `10`, `11`, ..

- **MICRO** – Patch version – `0`, `1`, `2`, ..

- **MODIFIER** – An optional text tag like `dev`, `alpha`, `beta`, `rc`, ..

Note this is basically the `YYYY.MINOR.MICRO(.MODIFIER)` pattern where `MINOR` indicates the round number (`RR`).

Examples:

- **2024.0.0.alpha** – Pre-season alpha release before the 1^st race round of the 2024 season.

- **2024.0.0.beta** – Pre-season beta release before the 1^st race round of the 2024 season.

- **2024.0.0** – Final pre-season release before the 1^st race round of the 2024 season.

- **2024.0.1** – First pre-season patch release before the 1^st race round of the 2024 season.

- **2024.1.0** – Final release after the 1^st race round of the 2024 season.

- **2024.2.0** – Final release after the 2^nd race round of the 2024 season.

- **2024.2.1** – First patch release after the 2^nd race round of the 2024 season.

- **2024.2.2** – Second patch release after the 2^nd race round of the 2024 season.

As you can see we use a special **RR** `0` for pre-season releases.

## Community

The F1DB community can be found on [GitHub Discussions](https://github.com/f1db/f1db/discussions), where you can ask and answer questions, voice ideas, and share your projects.

Keep in touch with us by following us on X — [@F1DB_com](https://twitter.com/f1db_com).

## Reporting Data Issues

We use [GitHub Issues](https://github.com/f1db/f1db/issues) to track data issues or related problems.

If you found a data issue which is not reported yet, please [create a new issue](https://github.com/f1db/f1db/issues/new).

## Building from Source

To build the distribution zips simply run:

    ./gradlew clean dist assemble

Requires Java 21.

## Releasing

[GitHub Actions](https://github.com/f1db/f1db/actions) is used to build and upload new releases by creating a new git tag.

Follow these steps:

1. Update the version number in `gradle.properties`

2. `git commit -am "Release v"`

3. `git push`

4. `git tag -a v -m "Release v"`

3. `git push origin v`

and the release action is automatically triggered by pushing the new tag.

## License

[![Creative Commons License][CC BY Icon Normal]][CC BY]

F1DB is licensed under a [Creative Commons Attribution 4.0 International License][CC BY].

[F1DB]: https://www.f1db.com

[CalVer]: https://calver.org/

[CC BY]: http://creativecommons.org/licenses/by/4.0/  

[CC BY Icon Compact]: https://i.creativecommons.org/l/by/4.0/80x15.png

[CC BY Icon Normal]: https://i.creativecommons.org/l/by/4.0/88x31.png

[CC BY Plaintext]: https://creativecommons.org/licenses/by-sa/4.0/legalcode.txt

[SQLiteStudio]: https://sqlitestudio.pl/