https://github.com/pschmitt/sherlockbikepy
Python library to interact with the sherlock.bike API
https://github.com/pschmitt/sherlockbikepy
api bike gps iot python sherlock-bike
Last synced: about 1 month ago
JSON representation
Python library to interact with the sherlock.bike API
- Host: GitHub
- URL: https://github.com/pschmitt/sherlockbikepy
- Owner: pschmitt
- License: gpl-3.0
- Created: 2018-09-22T16:03:42.000Z (almost 8 years ago)
- Default Branch: master
- Last Pushed: 2018-09-23T08:51:20.000Z (almost 8 years ago)
- Last Synced: 2025-12-26T15:10:54.649Z (6 months ago)
- Topics: api, bike, gps, iot, python, sherlock-bike
- Language: Python
- Homepage: https://pypi.org/project/sherlockbikepy/
- Size: 36.1 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# sherlockbikepy
This Python library implements the [sherlock.bike](https://sherlock.bike) API. It has been reverse
engineered from the [Android app](https://play.google.com/store/apps/details?id=bike.sherlock.app).
## Installation
```bash
pip install sherlockbikepy
```
## Code snippet
```python
from sherlockbikepy import Sherlock
# Login
sh = Sherlock('user@example.com', 'supaSecretPassw0rd')
# Get devices
sh.devices
# > []
# Primary device (ie. the first one)
sh.primary_device
# >
# Device state
sh.primary_device.state
# > 'ON'
# Device location (only available if currently armed ie. "ON")
sh.primary_device.location
# > Position(latitude=20.6297038,
# > longitude=2.8123654,
# > last_update=datetime.datetime(2018, 9, 22, 15, 55, 42))
```