From 305d542375c062f4b69504a7d44502fc675592ab Mon Sep 17 00:00:00 2001 From: Jason Meno Date: Sat, 3 Oct 2020 12:24:18 -0400 Subject: [PATCH] docs: Specify Python 3 in README --- README.md | 13 +++++++++---- 1 file changed, 9 insertions(+), 4 deletions(-) diff --git a/README.md b/README.md index 43ff8f9..3bbf04a 100644 --- a/README.md +++ b/README.md @@ -6,16 +6,19 @@ A simple script to convert Apple Health's export.xml file to an easy to use csv. ## How to Run -### 1. Verify you have pandas installed on your machine or environment +### 1. Verify you have Python 3 & Pandas installed on your machine or environment + +`python --version` should return _Python 3.x.x_ where x is any number. + +If you have Python 2.x.x, please upgrade to Python 3 here: https://www.python.org/downloads/ (or specify your environment's Python version) `python -c "import pandas"` should return blank from the command line -If you get a _**ModuleNotFoundError: No module named 'pandas'**_ error, install pandas: +If you get a _**ModuleNotFoundError: No module named 'pandas'**_ error, install pandas and try again: `pip install pandas` - ### 2. Export your Apple Health Data Go to your health home screen and click on the profile icon @@ -39,7 +42,7 @@ Your data will be prepared, and then you can transfer the export.zip file to you -### 4. Place the "apple_health_xml_convert.py" file into the folder alongside the files and run the script +### 4. Place the "apple_health_xml_convert.py" file from this repo into the folder alongside the files and run the script `python apple_health_xml_convert.py` @@ -54,3 +57,5 @@ The export will be written with the format: In Excel, the output should look something like this: + +Note: This script removes the Apple Health data prefixes: `HKQuantityTypeIdentifier`, `HKCategoryTypeIdentifier`, and `HKCharacteristicTypeIdentifier` for increased legibility. Feel free to comment out those lines in the code with a `#` if you want to keep them in the CSV output.