Skip to main content

Python library to interact with the sherlock.bike API

Project description

# 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).

## Code snippet

```python
from sherlockbikepy import Sherlock

# Login
sh = Sherlock('user@example.com', 'supaSecretPassw0rd')

# Get devices
sh.devices
# > [<sherlockbikepy.device.SherlockDevice at 0x7fa840410400>]

# Primary device (ie. the first one)
sh.primary_device
# > <sherlockbikepy.device.SherlockDevice at 0x7fa840421b38>

# 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))
```

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for sherlockbikepy, version 0.1
Filename, size File type Python version Upload date Hashes
Filename, size sherlockbikepy-0.1.tar.gz (3.5 kB) File type Source Python version None Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page