ipyhealth 0.1.2

A library to parse, wrangle and plot Apple Health data.

ipyhealth

ipyhealth is a Python3 library to parse, wrangle and plot Apple Health data from all Apple devices.

ipyhealth makes it easy for developers to obtain the Apple Health data, saved as four pandas dataframes:

1. 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: dataframe containing type (Walk, Run, Hike, Yoga, etc.), duration, energy burned and distance of a recorded workout.

3. Activity Summary: dataframe containing the move, exercise and stand data for a given day.

4. Routes: 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) under the MIT license.

Installation

Install using pip with:

pip install ipyhealth

Or install from Github using:

pip install git+https://github.com/mereldawu/ipyhealth.git

Usage

from ipyhealth.parser import AppleHealthParser

health_data = AppleHealthParser(
      in_file = '/location/to/apple_health_export',
      from_date = None, # date to start parsing, i.e. datetime(2020, 5, 1)
      verbose = True, # print extract progress and success status, i.e. True/False
      nprocs = 4 # number of CPUs to use
)

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 (this takes some time).

3. Select Save to Files (this is only available for iOS 13 and above, for lower verions of iOS 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 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.

History

0.1.0 (2020-05-14)

• First release on PyPI.

0.1.1 (2020-05-14)

• Add readthedocs

• Add badges on build and docs

0.1.2 (2020-05-14)

• Fix typo

• Update example to include other usages