Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/raman325/pypeloton
Peloton API Client
https://github.com/raman325/pypeloton
peloton
Last synced: 3 days ago
JSON representation
Peloton API Client
- Host: GitHub
- URL: https://github.com/raman325/pypeloton
- Owner: raman325
- License: mit
- Created: 2020-05-02T03:24:16.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2023-12-15T14:47:05.000Z (11 months ago)
- Last Synced: 2024-09-18T01:17:22.975Z (about 2 months ago)
- Topics: peloton
- Language: Python
- Homepage:
- Size: 28.3 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# pypeloton
Peloton API Client
## Installation
### Use pip
`pip install pypeloton`
### Build locally
```
$ git clone https://github.com/raman325/pypeloton.git
$ pip install -I pypeloton
```
## Usage
There are synchronous (`Peloton`) and asynchronous (`PelotonAsync`) classes available with the same methods available. For the purpose of demonstration we will talk about the synchronous `Peloton` class.
```
from pypeloton import Peloton
client = Peloton("my_username_or_email", "my_password")
user_id = client.get_user_id("raman325")
print(client.get_user_achievements(user_id))
print(client.get_user_workouts(user_id))
```
Most functions will return the full payload received, so it is up to you to figure out how to get the data you need from a given method. As of now you will have to look at the source to see what functions are available, better documentation to come later.
## Acknowledgements
- @geudrik made some helpful [API docs](https://github.com/geudrik/peloton-client-library/blob/master/API_DOCS.md)
- @