add loader for apple health data

Author: rip-tyang

.gitignore

@@ -1,3 +1,6 @@
+# Mac OS folder attribution file
+.DS_Store
+
 # Byte-compiled / optimized / DLL files
 __pycache__/
 *.py[cod]

README.md

@@ -50,6 +50,7 @@ Make everything a GitHub svg poster and [skyline](https://skyline.github.com/)!
 - **[Covid](#Covid)**
 - **[Todoist](#Todoist)**
 - **[开言英语](#开言英语)**
+- **[Apple Health](#AppleHealth)**
 
 ## 下载
 
@@ -634,6 +635,21 @@ github_poster openlanguage --year 2021-2022 --openlanguage_user_name "you accoun
 ```
 </details>
 
+### AppleHealth
+<details>
+<summary>Make <code> Apple Health </code> GitHub poster</summary>
+
+Apple Health 里有丰富的数据，此 loader 暂时只支持 Apple Watch Activity 里的三大项，即 Move，Exercise，Stand。但理论上任何 Apple Health 里的数据都能支持。
+打开 Health App, 点击右上方头像，选择 Export All Health Data, 将所得压缩包拷贝到 `IN-FOLDER` 后解压，会得到一个 `apple_health_export` 文件夹。之后运行:
+<br>
+
+```
+python3 -m github_poster apple_health --year 2015-2021 --apple_health_record_type <move, exercise, stand> --me "your name"
+or
+github_poster apple_health --year 2015-2021 --apple_health_record_type <move, exercise, stand> --me "your name"
+```
+</details>
+
 # 参与项目
 
 - 任何 Issues PR 均欢迎。

github_poster/config.py

@@ -47,4 +47,5 @@
     "weread": "WeRead",
     "covid": "COVID-19",
     "todoist": "Todoist",
+    "apple": "AppleHealth",
 }

github_poster/loader/__init__.py

@@ -1,3 +1,4 @@
+from github_poster.loader.apple_health_loader import AppleHealthLoader
 from github_poster.loader.bbdc_loader import BBDCLoader
 from github_poster.loader.bilibili_loader import BilibiliLoader
 from github_poster.loader.cichang_loader import CiChangLoader
@@ -29,6 +30,7 @@
 from github_poster.loader.youtube_loader import YouTubeLoader
 
 LOADER_DICT = {
+    "apple_health": AppleHealthLoader,
     "bbdc": BBDCLoader,
     "duolingo": DuolingoLoader,
     "shanbay": ShanBayLoader,
@@ -61,6 +63,7 @@
 }
 
 __all__ = (
+    "AppleHealthLoader",
     "BilibiliLoader",
     "CiChangLoader",
     "Dota2Loader",

github_poster/loader/apple_health_loader.py

@@ -0,0 +1,91 @@
+import os
+import xml.etree.ElementTree as ET
+from collections import defaultdict, namedtuple
+
+import pendulum
+
+from github_poster.loader.base_loader import BaseLoader
+
+# func is a lambda that converts the "value" attribute of the record to a numeric value.
+RecordMetadata = namedtuple("RecordMetadata", ["type", "unit", "track_color", "func"])
+
+
+SUPPORTED_HEALTH_RECORD_TYPES = {
+    "move": RecordMetadata(
+        "HKQuantityTypeIdentifierActiveEnergyBurned",
+        "kCal",
+        "#ED619C",
+        lambda x: float(x),
+    ),
+    "exercise": RecordMetadata(
+        "HKQuantityTypeIdentifierAppleExerciseTime", "mins", "#D7FD37", lambda x: int(x)
+    ),
+    "stand": RecordMetadata(
+        "HKCategoryTypeIdentifierAppleStandHour",
+        "hours",
+        "#62F90B",
+        lambda x: 1 if "HKCategoryValueAppleStandHourStood" else 0,
+    ),
+}
+
+
+class AppleHealthLoader(BaseLoader):
+    def __init__(self, from_year, to_year, _type, **kwargs):
+        super().__init__(from_year, to_year, _type)
+        self.number_by_date_dict = defaultdict(int)
+        self.apple_health_export_file = kwargs.get("apple_health_export_file")
+        self.apple_health_record_type = kwargs.get("apple_health_record_type")
+
+    @classmethod
+    def add_loader_arguments(cls, parser, optional):
+        parser.add_argument(
+            "--apple_health_export_file",
+            dest="apple_health_export_file",
+            type=str,
+            default=os.path.join("IN_FOLDER", "apple_health_export", "export.xml"),
+            help="Apple Health export file path",
+        )
+        parser.add_argument(
+            "--apple_health_record_type",
+            dest="apple_health_record_type",
+            choices=SUPPORTED_HEALTH_RECORD_TYPES.keys(),
+            default="move",
+            help="Apple Health Record Type",
+        )
+
+    def make_track_dict(self):
+        record_metadata = SUPPORTED_HEALTH_RECORD_TYPES[self.apple_health_record_type]
+        self.__class__.unit = record_metadata.unit
+        self.__class__.track_color = record_metadata.track_color
+
+        in_target_section = False
+        for _, elem in ET.iterparse(self.apple_health_export_file, events=["end"]):
+            if elem.tag != "Record":
+                continue
+
+            if elem.attrib["type"] == record_metadata.type:
+                in_target_section = True
+                create_date = pendulum.from_format(
+                    elem.attrib["creationDate"], "YYYY-MM-DD HH:mm:ss ZZ"
+                )
+                if (
+                    create_date.year >= self.from_year
+                    and create_date.year <= self.to_year
+                ):
+                    self.number_by_date_dict[
+                        create_date.to_date_string()
+                    ] += record_metadata.func(elem.attrib["value"])
+            elif in_target_section:
+                break
+
+            elem.clear()
+
+        self.number_by_date_dict = {
+            k: int(v) for k, v in self.number_by_date_dict.items()
+        }
+        self.number_list = list(self.number_by_date_dict.values())
+
+    def get_all_track_data(self):
+        self.make_track_dict()
+        self.make_special_number()
+        return self.number_by_date_dict, self.year_list