Library for the Withings API
Project description
Python withings-api
Python library for the Withings Health API
Withings Health API https://developer.withings.com/oauth2/
Uses OAuth 2.0 to authenticate. You need to obtain a client id and consumer secret from Withings by creating an application here: http://developer.withings.com/oauth2/
Installation
pip install withings-api
Usage
For a complete example, checkout the integration test in scripts/integration_test.py. It has a working example on how to use the API.
from withings_api import WithingsAuth, WithingsApi, AuthScope
from withings_api.common import get_measure_value, MeasureType
auth = WithingsAuth(
client_id='your client id',
consumer_secret='your consumer secret',
callback_uri='your callback uri',
mode='demo', # Used for testing. Remove this when getting real user data.
scope=(
AuthScope.USER_ACTIVITY,
AuthScope.USER_METRICS,
AuthScope.USER_INFO,
AuthScope.USER_SLEEP_EVENTS,
)
)
authorize_url = auth.get_authorize_url()
# Have the user goto authorize_url and authorize the app. They will be redirected back to your redirect_uri.
credentials = auth.get_credentials('code from the url args of redirect_uri')
# Now you are ready to make calls for data.
api = WithingsApi(credentials)
meas_result = api.measure_get_meas()
weight_or_none = get_measure_value(meas_result, with_measure_type=MeasureType.WEIGHT)
Building
Building, testing and lintings of the project is all done with one script. You only need a few dependencies.
Dependencies:
- python3 in your path.
- The python3
venvmodule.
The build script will setup the venv, dependencies, test and lint and bundle the project.
./script/build.sh
Integration Testing
There exists a simple integration test that runs against Withings' demo data. It's best to run this after you have successful builds.
Note: after changing the source, you need to run build for the integration test to pickup the changes.
./script/build.sh
source ./venv/bin/activate
./script/integration_test.py --client-id <your client id> --consumer-secret <your consumer secret> --callback-uri <your clalback uri>
The integration test will cache the credentials in a <project root>/.credentials file between runs. If you get an error saying
the access token expired, then remove that credentials file and try again.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
File details
Details for the file withings_api-2.0.0.tar.gz.
File metadata
- Download URL: withings_api-2.0.0.tar.gz
- Upload date:
- Size: 10.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/1.15.0 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.4.0 requests-toolbelt/0.9.1 tqdm/4.36.1 CPython/3.5.6
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | f9b751089d86a88eaa120a7f2edd4b0002fe469095b012196f8d64b6e16474ad |
|
| MD5 | 28e50dd4d591a28b009ae8007ae1b69f |
|
| BLAKE2b-256 | 0f2b8b6fc95874382228af8bbcd383d364671f40b10684f0bbf69184047a91bd |
