Skip to content
 
 

Repository files navigation

F1PyStats

F1PyStats is an open-source Python3 package that provides Formula 1 data/statistics to developers. This package obtains Formula 1 data via the Ergast Developer API, and returns results in a pandas DataFrame format.

Installation

Prerequisite

The package uses Poetry as the primary dependency management tool. To install Poetry follow their official documentation at link

// Clone the repo
$ git clone https://github.com/alec-kr/F1PyStats.git

// Install dependecies using poetry
$ cd ../F1PyStats
$ poetry install --only main

// Build the package if you would to use it in other projects (https://python-poetry.org/docs/cli/#build)
poetry build

// Install built package (https://python-poetry.org/docs/cli/#add)
poetry add ../F1Pystats/dist/f1pystats-0.1.0.whl

Usage

# Import the package
import F1PyStats as fp

The package currently contains five functions

Function Description Returned Datatype
fp.driver_standings(year) Returns the driver standings for a particular year Pandas DataFrame
fp.constructor_standings(year) Returns the constructor standings for a specified year Pandas DataFrame
fp.race_winners(year) Returns the race winners for a specified year Pandas DataFrame
fp.race_table(year) Returns the race schedule for a specific year Pandas DataFrame
fp.lap_times(year, race_round, lap_number) Returns the lap times for a specific lap in a particular race Pandas DataFrame
fp.pit_stops(year, round, stop_number) Returns the pit stop info for a specific race/pit stop Pandas DataFrame

Contributions

  • Have a feature you would like to add? Feel free to create a PR 😄.
  • Spot an issue or bug? Please let us know by creating an issue. 🐛

About

An open-source Python3 package that provides Formula 1 data to developers.

Resources

Code of conduct

Contributing

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages