Metadata-Version: 2.1
Name: ipyhealth
Version: 0.1.0
Summary: A library to parse, wrangle and plot Apple Health data.
Home-page: https://github.com/mereldawu/ipyhealth
Author: Merelda Wu
Author-email: merelda@melio.co.za
License: MIT license
Description: =========
        ipyhealth
        =========
        
        
        .. image:: https://img.shields.io/pypi/v/ipyhealth.svg
                :target: https://pypi.python.org/pypi/ipyhealth
        
        .. image:: https://img.shields.io/travis/mereldawu/ipyhealth.svg
                :target: https://travis-ci.com/mereldawu/ipyhealth
        
        .. .. image:: https://readthedocs.org/projects/ipyhealth/badge/?version=latest
        ..         :target: https://ipyhealth.readthedocs.io/en/latest/?badge=latest
        ..         :alt: Documentation Status
        
        
        ipyhealth is a Pythoon3 library to parse, wrangle and plot `Apple Health data <https://developer.apple.com/documentation/healthkit/>`_ from all Apple devices.
        
        ipyhealth makes it easy for developers to obtain the Apple Health data, saved as four `pandas` dataframe:
        
        1. `Samples <https://developer.apple.com/documentation/healthkit/samples>`_: data that is recorded at a specific time, including HKQuantitySample (height, heart rate, energy consumed, etc.), HKCategorySample (user in bed, asleep, or awake) and HKCorrelation (food and blood pressure).
        
        2. `Workouts <https://developer.apple.com/documentation/healthkit/workouts_and_activity_rings>`_: dataframe containing type (Walk, Run, Hike, Yoga, etc.), duration, energy burned and distance of a recorded workout.
        
        3. `Activity Summary <https://developer.apple.com/documentation/healthkit/hkactivitysummary>`_: dataframe containing the move, exercise and stand data for a given day.
        
        4. `Routes <https://developer.apple.com/documentation/healthkit/workouts_and_activity_rings/reading_route_data>`_: dataframe containing the location of the route file (.gpx file exported), the latitude, lonitude and elevation at different points of the route.
        
        © ipyhealth contributors 2020 (see `AUTHORS <https://github.com/mereldawu/ipyhealth/blob/master/AUTHORS.rst>`_) under the `MIT license <https://github.com/mereldawu/ipyhealth/blob/master/LICENSE>`_.
        
        .. * Documentation: https://ipyhealth.readthedocs.io.
        
        
        Installation
        -------------
        
        Install using `pip <https://pip.pypa.io/en/latest/>`_ with:
        
                pip install ipyhealth
        
        Or install from Github using:
        
                pip install git+https://github.com/mereldawu/ipyhealth.git
        
        
        Usage
        ------
        .. code-block:: python
        
          from ipyhealth.parser import AppleHealthParser
        
          health_data = AppleHealthParser('/location/to/apple_health_export')
        
          type(health_data.records) # pd.DataFrame
          type(health_data.workouts) # pd.DataFrame
          type(health_data.activities) #pd.DataFrame
          type(health_data.routes) #pd.DataFrame
        
        
        To export Apple Health data
        ----------------------------
        
        Download and extract the Apple Health data to a desired location:
        
        1. On your iPhone, open Health App.
        2. Click on your avatar > Scroll to the bottom > Export all health data.
        3. Select Save to Files (save at a location where you can read it).
        4. Unzip the export.zip folder, which contains `apple_health_export` folder:
        
        | apple_health_export
        | ├── export.xml (the main file that is parsed)
        | ├── export_cda.xml (the `Clinical Document Architecture <https://en.wikipedia.org/wiki/Clinical_Document_Architecture>`_ file is not used)
        | ├── **workout_routes**
        |    ├── route_{timestamp}.gpx (the GPS data for the associated workout)
        |    ├──route_{timestamp}.gpx (these contain the location information)
        
        
        
        Credits
        -------
        
        This package was created with Cookiecutter_ and the `audreyr/cookiecutter-pypackage`_ project template.
        
        .. _Cookiecutter: https://github.com/audreyr/cookiecutter
        .. _`audreyr/cookiecutter-pypackage`: https://github.com/audreyr/cookiecutter-pypackage
        
        
        =======
        History
        =======
        
        0.1.0 (2020-05-14)
        ------------------
        
        * First release on PyPI.
        
Keywords: ipyhealth
Platform: UNKNOWN
Classifier: Development Status :: 2 - Pre-Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Natural Language :: English
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Requires-Python: >=3.5
Description-Content-Type: text/x-rst
