Skip to content

Latest commit

 

History

History
42 lines (24 loc) · 1.43 KB

File metadata and controls

42 lines (24 loc) · 1.43 KB

Peloton API Wrapper

Work In Progress

This project will interact with the Peloton API to retrieve data using the unofficial Peloton API

Project is focused on graphing data returned from the Peloton API.

Current state: Return all workouts from the Peloton API as a list of dictionaries, and the ability to query a specific workout based on the ID. This logic is handled in peloton/client.py which acts as a API wrapper.

Current Status

Return all personal best cycling workouts and specifics about that ride (instructor, name, music, etc.).

Future Plans (issues opened in GitHub)

Graph total_effort based on cycling time (ignore anything less than 10 because these are warm up, cool down, or abandoned rides).

Requirements

Python 3.11.0
Requests 2.28.1

Consuming

Create a Python virtual environment and install the dependencies using pip install -r requirements.txt

If you are using Pipenv a Pipfile has been included. To install the dependencies use pipenv install

Rename .env.example to .env and populate your variables in this file. The .env is included in the .gitignore to ensure it does not accidently get checked into a git repo.

A main.py file has been included that will return all workouts to validate success. To return all workouts execute python main.py.

License

MIT

See LICENSE.md for the full text.