feat: heart rate svg animate

Author: yihong0618

.github/workflows/replace_readme.yml

@@ -26,18 +26,33 @@ jobs:
         uses: actions/setup-python@v1
         with:
           python-version: 3.6
-      - name: Test
+      # from pdm
+      - name: Set Variables
+        id: set_variables
         run: |
-          echo  ${{ github.event.inputs.test }}
-      - name: Replace README
+          echo "::set-output name=PY::$(python -c 'import hashlib, sys;print(hashlib.sha256(sys.version.encode()+sys.executable.encode()).hexdigest())')"
+          echo "::set-output name=PIP_CACHE::$(pip cache dir)"
+
+      - name: Cache PIP
+        uses: actions/cache@v2
+        with:
+          path: ${{ steps.set_variables.outputs.PIP_CACHE }}
+          key: Ubuntu-pip-${{ steps.set_variables.outputs.PY }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          pip install -r requirements.txt
+        if: steps.pip-cache.outputs.cache-hit != 'true'
+
+      - name: Replace README AND generate SVG
         run: |
           python main.py '${{ github.event.inputs.time }}' '${{ github.event.inputs.value }}'
       - name: Push new README
         uses: github-actions-x/[email protected]
         with:
           github-token: ${{ secrets.G_T }}
           commit-message: "Replace README"
-          files: README.md
+          files: README.md files
           rebase: 'true'
-          name: yihong0618 
-          email: [email protected]
+          name: ${{ env.GITHUB_NAME }}
+          email: ${{ env.GITHUB_EMAIL }}

files/heart.svg

@@ -0,0 +1 @@
+from .heart import Heart

heart/__init__.py

@@ -0,0 +1,9 @@
+BASE_TRANSLATE = "translate(100 100)"
+TWO_LETTERS_TEXT_TRANSLATE = "translate(-12.5 0)"
+THREE_LETTERS_TEXT_TRANSLATE = "translate(-17.5 0)"
+BASE_PATH_TRANSLATE = "translate(-50 -50)"
+BASE_HEART_COLOR = "tomato"
+BASE_HEART_TEXT_COLOR = "bisque"
+BASE_TEXT_STYLE = "font-size:25px; font-family:Arial"
+
+PATH_D = "M92.71,7.27L92.71,7.27c-9.71-9.69-25.46-9.69-35.18,0L50,14.79l-7.54-7.52C32.75-2.42,17-2.42,7.29,7.27v0 c-9.71,9.69-9.71,25.41,0,35.1L50,85l42.71-42.63C102.43,32.68,102.43,16.96,92.71,7.27z"

heart/config.py

@@ -0,0 +1,123 @@
+from bisect import bisect
+
+import svgwrite
+from svgwrite.animate import Animate, AnimateTransform
+
+from .config import (
+    BASE_HEART_COLOR,
+    BASE_HEART_TEXT_COLOR,
+    BASE_PATH_TRANSLATE,
+    BASE_TEXT_STYLE,
+    BASE_TRANSLATE,
+    PATH_D,
+    THREE_LETTERS_TEXT_TRANSLATE,
+    TWO_LETTERS_TEXT_TRANSLATE,
+)
+from .utils import intersperse, make_key_times, make_key_values
+
+
+class Heart:
+    def __init__(self, file_path, base_height=150, base_width=150):
+        self.file_path = file_path
+        self.base_height = base_height
+        self.base_width = base_width
+        self.values = None
+        self.dur = None
+        self.letters_trans_dict = {
+            2: TWO_LETTERS_TEXT_TRANSLATE,
+            3: THREE_LETTERS_TEXT_TRANSLATE,
+        }
+        self._make_drawer()
+
+    def _make_drawer(self):
+        self.drawer = svgwrite.Drawing(
+            self.file_path, (str(self.base_height), str(self.base_width))
+        )
+        self.drawer.viewbox(0, 0, 200, 200)
+
+    def set_values(self, values):
+        self.values = values
+        # from start -> end (heart rate timeline)
+        self.values.reverse()
+
+    def _make_g(self):
+        return self.drawer.g(transform=BASE_TRANSLATE)
+
+    def _make_path(self):
+        return self.drawer.path(
+            fill=BASE_HEART_COLOR,
+            transform=BASE_PATH_TRANSLATE,
+            d=PATH_D,
+            stroke="#B6BBC1",
+            stroke_width=2,
+        )
+
+    def _make_base_animate_transform(self):
+        values = self._make_heart_scale_values()
+        values_str = ";".join(values) + ";"
+        return AnimateTransform(
+            type="scale",
+            dur=self.dur,
+            values=values_str,
+            repeatCount="indefinite",
+            additive="sum",
+            transform="scale",
+        )
+
+    def _make_animate(self, index):
+        num_count = len(self.values)
+        a = Animate(
+            "opacity",
+            dur=self.dur,
+            values=make_key_values(num_count, index),
+            keyTimes=make_key_times(num_count),
+            repeatCount="indefinite",
+        )
+        return a
+
+    def _make_text(self, value, index):
+        transform = self.letters_trans_dict.get(len(value))
+        t = self.drawer.text(
+            str(value),
+            transform=transform,
+            fill=BASE_HEART_TEXT_COLOR,
+            style=BASE_TEXT_STYLE,
+        )
+        text_anmiate = self._make_animate(index)
+        t.add(text_anmiate)
+        return t
+
+    def __compute_statistics(self):
+        if not self.values:
+            raise Exception("No heart rate values set")
+        dur_break_points = (5, 10, 15, 20)
+        i = bisect(dur_break_points, len(self.values))
+        self.dur = str(12 * i) + "s"
+
+    def _make_heart_scale_values(self):
+        """
+        break_points -> scale number
+        """
+        break_points = ("0.625", "0.75", "0.875", "1.125", "1.25", "1.375", "1.5")
+        min_value, max_value = min(self.values), max(self.values)
+        interval = (max_value - min_value) / 5
+        heart_rate_points = [min_value + interval * i for i in range(5)]
+        heart_rate_points.append(max_value)
+        heart_scale_list = [
+            break_points[bisect(heart_rate_points, i)] for i in self.values
+        ]
+        # Make the effect of a beating heart
+        heart_scale_list = intersperse(heart_scale_list, "1")
+        return heart_scale_list
+
+    def make_heart_svg(self):
+        self.__compute_statistics()
+        g = self._make_g()
+        path = self._make_path()
+        path_animate = self._make_base_animate_transform()
+        g.add(path)
+        g.add(path_animate)
+        for index, v in enumerate(self.values):
+            g.add(self._make_text(str(v), index))
+        self.drawer.add(g)
+        self.drawer.save()

heart/heart.py

@@ -0,0 +1,25 @@
+from itertools import count, takewhile
+
+
+def make_key_times(num_count):
+    """
+    return: list of key times points
+    should append `1` because the svg keyTimes rule
+        5 -> 0;0.2;0.4;0.6;0.8;1
+    """
+    s = list(takewhile(lambda n: n < 1, count(0, 1 / num_count)))
+    if not round(s[-1], 2) == 1.0:
+        s.append(1)
+    return ";".join([str(round(i, 2)) for i in s])
+
+
+def make_key_values(num_count, index):
+    l = ["0"] * (num_count + 1)
+    l[index] = "1"
+    return ";".join(l)
+
+
+def intersperse(lst, item):
+    result = [item] * (len(lst) * 2 - 1)
+    result[0::2] = lst
+    return result

heart/utils.py

@@ -1,11 +1,15 @@
 import re
 import argparse
+import os
+
+from heart import Heart
 
 GITHUB_README_COMMENTS = (
     "(<!--START_SECTION:{name}-->\n)(.*)(<!--END_SECTION:{name}-->\n)"
 )
 HEART_RATE_HEAD = "| Time | Rate | \n | ---- | ---- | \n"
 HEART_RATE_STAT_TEMPLATE = "| {time} | {value} |\n"
+OUT_FOLDER = os.path.join(os.getcwd(), "files")
 
 
 def replace_readme_comments(file_name, comment_str, comments_name):
@@ -39,10 +43,16 @@ def make_summary_str(time_list, value_list):
 def main(time_list_str, value_list_str):
     time_list = parse_ios_str_to_list(time_list_str)
     value_list = parse_ios_str_to_list(value_list_str)
-    print(time_list, value_list)
+    value_list = [int(i) for i in value_list]
+
     s = make_summary_str(time_list, value_list)
     replace_readme_comments("README.md", s, "my_heart_rate")
 
+    # generate heart rate svg and save
+    h = Heart(os.path.join(OUT_FOLDER, "heart.svg"))
+    h.set_values(value_list)
+    h.make_heart_svg()
+
 
 if __name__ == "__main__":
     parser = argparse.ArgumentParser()

main.py

@@ -0,0 +1 @@
+git+https://github.com/yihong0618/svgwrite.git