Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jshrake/healthkit-to-sqlite
Command-line tool to convert Apple HealthKit data to a SQLite database.
https://github.com/jshrake/healthkit-to-sqlite
datasette healthkit sqlite
Last synced: 3 months ago
JSON representation
Command-line tool to convert Apple HealthKit data to a SQLite database.
- Host: GitHub
- URL: https://github.com/jshrake/healthkit-to-sqlite
- Owner: jshrake
- License: apache-2.0
- Created: 2022-12-31T05:07:29.000Z (about 2 years ago)
- Default Branch: main
- Last Pushed: 2023-01-18T14:20:36.000Z (almost 2 years ago)
- Last Synced: 2024-10-10T22:23:33.312Z (3 months ago)
- Topics: datasette, healthkit, sqlite
- Language: Rust
- Homepage:
- Size: 391 KB
- Stars: 8
- Watchers: 2
- Forks: 1
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE-APACHE
Awesome Lists containing this project
README
# healthkit-to-sqlite
[](https://github.com/jshrake/healthkit-to-sqlite/actions)
[](https://crates.io/crates/healthkit-to-sqlite-cli)
[](https://opensource.org/licenses/Apache-2.0)
[](https://opensource.org/licenses/MIT)
Command-line tool to convert Apple HealthKit data to a SQLite database.
## Getting Started
1. Open the [Health](https://www.apple.com/ios/health/) app on your iOS device.
2. Click your profile icon in the top-right corner.
3. Click the "Export All Health Data" button.
4. Share the resulting ZIP archive to your computer.
5. Run healthkit-to-sqlite on the exported ZIP archive.
```bash
# You need to install Rust https://rustup.rs/
cargo install healthkit-to-sqlite-cli
healthkit-to-sqlite export.zip sqlite://healthkit.db
```
Please [create an issue](https://github.com/jshrake/healthkit-to-sqlite/issues/new/choose) for all bugs, feature requests, or feedback.
## Example Queries
Here are a few example SQL queries to help you start exploring your HealthKit data:
* Total walking, running, and hiking workout duration in hours for the month of December 2022:
```sql
select
sum(duration) / 60 as total_duration
from
workout
where
(
creationDate between '2022-12-01' and '2022-12-31'
)
and (
workoutActivityType = 'HKWorkoutActivityTypeWalking' or
workoutActivityType = 'HKWorkoutActivityTypeRunning' or
workoutActivityType = 'HKWorkoutActivityTypeHiking'
);
```
* Total distance covered in miles across all workouts for the month of December 2022:
```sql
select
sum(
json_extract(
workoutStatistics,
"$.HKQuantityTypeIdentifierDistanceWalkingRunning.sum"
)
) as total_distance_miles
from
workout
where
(
creationDate between '2022-12-01'
and '2022-12-31'
);
```
* The JSON data in the `workoutStatistics` column looks like:
```json
{
"HKQuantityTypeIdentifierActiveEnergyBurned": {
"endDate": "2019-12-27 13:10:51 -0800",
"startDate": "2019-12-27 12:30:15 -0800",
"sum": 135.70199584960938,
"type": "HKQuantityTypeIdentifierActiveEnergyBurned",
"unit": "Cal"
},
"HKQuantityTypeIdentifierBasalEnergyBurned": {
"endDate": "2019-12-27 13:10:51 -0800",
"startDate": "2019-12-27 12:30:15 -0800",
"sum": 67.24250030517578,
"type": "HKQuantityTypeIdentifierBasalEnergyBurned",
"unit": "Cal"
},
"HKQuantityTypeIdentifierDistanceWalkingRunning": {
"endDate": "2019-12-27 13:10:51 -0800",
"startDate": "2019-12-27 12:30:15 -0800",
"sum": 1.4269200563430786,
"type": "HKQuantityTypeIdentifierDistanceWalkingRunning",
"unit": "mi"
}
}
```
## Datasette
You can use to view and explore the resulting SQLite database file.
```bash
datasette healthkit.db
```
* Install the plugin to visualize all workout routes in the `Workout` table on a single map.
* Install the plugin to render an in-row map for each workout route in the `Workout` table.
```bash
datasette install datasette-geojson-map
datasette install datasette-leaflet-geojson
```
## Decisions
* Only the `Record`, `Workout`, and `ActivitySummary` elements are currently exported.
* `Record` elements are inserted to a table with a name matching the value of the element's `type` attribute.
* `Workout` elements are inserted to a table named "Workout".
* The descendent `workoutEvent` and `workoutStatistics` elements are represented as JSON columns.
* The descendent `workoutRoute` element is converted to a GeoJSON LineString and stored in a JSON column named "geometry" for easy integration with .
* `ActivitySummary` elements are inserted as rows to a table named "ActivitySummary".
* In an attempt to future proof against Apple adding, removing, or changing element attributes, the code only assumes the existence of a limited number of attributes:
* `Record` elements must have a `type` attribute.
* `Workout` elements must have a `workoutActivity` attribute.
* `MetadataEntry` elements must have `key` and `value` attributes.
* `FileReference` elements must have a `path` attribute.
## License
This project is licensed under either of
* Apache License, Version 2.0, ([LICENSE-APACHE](/LICENSE-APACHE) or )
* MIT license ([LICENSE-MIT](/LICENSE-MIT) or )
at your option.