Giter VIP home page Giter VIP logo

wearipedia's Introduction

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": "[email protected]", "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

wearipedia's People

Contributors

rodrigo-castellon avatar a-llison-lau avatar trafficcop avatar saarthshah avatar dependabot[bot] avatar m7-soliman avatar cheejung avatar hetavv avatar cthev456 avatar suvan-kumar avatar kizjkre avatar jtseng20 avatar rjcaste-2 avatar

Recommend Projects

  • React photo React

    A declarative, efficient, and flexible JavaScript library for building user interfaces.

  • Vue.js photo Vue.js

    ๐Ÿ–– Vue.js is a progressive, incrementally-adoptable JavaScript framework for building UI on the web.

  • Typescript photo Typescript

    TypeScript is a superset of JavaScript that compiles to clean JavaScript output.

  • TensorFlow photo TensorFlow

    An Open Source Machine Learning Framework for Everyone

  • Django photo Django

    The Web framework for perfectionists with deadlines.

  • D3 photo D3

    Bring data to life with SVG, Canvas and HTML. ๐Ÿ“Š๐Ÿ“ˆ๐ŸŽ‰

Recommend Topics

  • javascript

    JavaScript (JS) is a lightweight interpreted programming language with first-class functions.

  • web

    Some thing interesting about web. New door for the world.

  • server

    A server is a program made to process requests and deliver data to clients.

  • Machine learning

    Machine learning is a way of modeling and interpreting data that allows a piece of software to respond intelligently.

  • Game

    Some thing interesting about game, make everyone happy.

Recommend Org

  • Facebook photo Facebook

    We are working to build community through open source technology. NB: members must have two-factor auth.

  • Microsoft photo Microsoft

    Open source projects and samples from Microsoft.

  • Google photo Google

    Google โค๏ธ Open Source for everyone.

  • D3 photo D3

    Data-Driven Documents codes.