Skip to content

Latest commit

 

History

History
40 lines (33 loc) · 2.16 KB

README.md

File metadata and controls

40 lines (33 loc) · 2.16 KB

Motorsport Standings API

A simple API written in Python that scraps the FIA website for the current year drivers championship standings. The API currently scraps the FIA website for the World Endurance Championship, World Rally Championship and Formula 1 standings.

Avaliable endpoints

GET /wrc

Returns the 10 first competitors in the FIA World Rally Championship for the current year

Example:

GET /f1 return

GET /wec

Returns the 20 first competitors in the FIA World Endurance Championship for the current year

Example:

GET /f1 return

GET /f1

Returns the 10 first competitors in the FIA Formula 1 Championship for the current year

Example:

GET /f1 return

PS: Every endpoint has as optional parameter to limit the competitors returned by championship

Instalation

Via Docker

The installation via Docker is pretty easy:

  1. Make sure Docker is installed;
  2. Download the repository;
  3. Open a terminal on the root folder of the repository;
  4. Run docker compose up --build and the API should be ready to go;

Manually

The manual installation can be done following the steps below:

  1. Make sure pip is installed;
  2. Download the repository;
  3. Open a terminal on the root folder of the repository;
  4. Run pip install -r requirements.txt and then python main.py and the API should be working;