Skip to main content

Wearable data for all

Project description

wearipedia

Build status Python Version Dependencies Status

Code style: black Security: bandit Pre-commit Semantic Versions License Coverage Report

A one-stop shop for wearable device data extraction and simulation

Wearipedia provides a one-stop shop for accessing and extracting data from wearable devices.

Data from these devices may be used for:

  • Clinical research
  • Personal health monitoring
  • Health coaching
  • Health product development
  • Wearable device development

Wearipedia is developed and maintained by the Snyder Lab at the Stanford University.

Accessing data from wearable devices

The data from these devices is accessed using an easy-to-use API. In order to use this API, you will need to import the wearipedia module:

import wearipedia

Once you have imported the wearipedia module, accessing data from any wearable device is as easy as:

device = wearipedia.get_device("whoop/whoop_4")
device.authenticate({"email": "joesmith@gmail.com", "password": "foobar"})

# data is a DataFrame
data = device.get_data("metrics")

If you don't have access to your device, or need to demo data from a device without revealing your sensitive data or getting a device yourself, you can generate synthetic data, as shown below:

device = wearipedia.get_device("whoop/whoop_4")

# data is an automatically generated DataFrame
data = device.get_data("metrics")

and you're done!

Installing

The easiest way to install wearipedia is to use pip:

pip install wearipedia

We currently support Python 3.7, 3.8, and 3.9.

Supported Devices

Wearipedia supports the following devices:

Company Model Name Description Example Notebook Kinds of Data Available Unique name
Whoop Whoop The WHOOP 4.0 strap tracks sleep and activity data. Notebook cycles, hr. whoop/whoop_4
Garmin Fenix 7S The Garmin Fenix 7S is a watch that activity data. Notebook dates, steps, hrs, brpms. garmin/fenix_7s
Dexcom Pro CGM The Dexcom Pro CGM wearable device tracks blood sugar levels. Notebook dataframe. dexcom/pro_cgm
Withings Body+ The Withings Body+ is a smart scale that tracks weight and other metrics (body fat %). Notebook measurements. withings/bodyplus
Withings ScanWatch The Withings ScanWatch wearable device tracks sleep and activity data. Notebook heart_rates, sleeps. withings/scanwatch

Documentation

For more information on how to use wearipedia, please refer to our documentation.

Citing

A paper is in progress!

Disclaimer

This project is currently in alpha. This means that test coverage is limited, and the codebase is still really a prototype. Moreover, the API is unstable, as we are still rapidly iterating on it. Expect for most things to work, but also small bugs, rough edges, and sparse documentation.

Contributing

As Wearipedia is still at an early stage, we are not yet accepting contributions from the broader community. Once Wearipedia reaches its first stable release, we will begin accepting contributions.

License

Wearipedia is released under the MIT license.

Credits 🚀 Your next Python package needs a bleeding-edge project structure.

This project was generated with python-package-template

Project details


Download files

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

Source Distribution

wearipedia-0.1.3.tar.gz (101.3 kB view details)

Uploaded Source

Built Distribution

wearipedia-0.1.3-py3-none-any.whl (134.5 kB view details)

Uploaded Python 3

File details

Details for the file wearipedia-0.1.3.tar.gz.

File metadata

  • Download URL: wearipedia-0.1.3.tar.gz
  • Upload date:
  • Size: 101.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.9

File hashes

Hashes for wearipedia-0.1.3.tar.gz
Algorithm Hash digest
SHA256 71898880c053e1becc9dbc065aace62c07508af481b0dcf912934f2f6bacff7f
MD5 7fd0fce57d4616393e1766afb09046be
BLAKE2b-256 8d7650e066bb59f6f67a176c5d7aa4b5288a7fb614091d6e725fe6ba1c919f66

See more details on using hashes here.

File details

Details for the file wearipedia-0.1.3-py3-none-any.whl.

File metadata

  • Download URL: wearipedia-0.1.3-py3-none-any.whl
  • Upload date:
  • Size: 134.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/5.0.0 CPython/3.9.9

File hashes

Hashes for wearipedia-0.1.3-py3-none-any.whl
Algorithm Hash digest
SHA256 646307625728938e3ee65b4127be7d962035bb9d058062d2ecd8e249af293745
MD5 063f9610b897fbc1a00fabddeb2ce299
BLAKE2b-256 6e43239f81e2048ce97208b519021b7d3a1fc4e0f44e9ff426b1dbd21d80a847

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page