Merge pull request #39 from malkam03/hotfix-default-branch

Support default branches with names other than master

.github/FUNDING.yml

@@ -0,0 +1,4 @@
+# These are supported funding model platforms
+
+ko_fi: athulcyriac
+custom: https://www.buymeacoffee.com/JeVlc7T

.gitignore

@@ -0,0 +1,2 @@
+#generated when running the tests
+__pycache__/

.travis.yml

@@ -0,0 +1,7 @@
+language: python
+python:
+  - "3.7"
+install:
+  - pip install -r requirements.txt
+script:
+  - python -m unittest discover

README.md

@@ -1,8 +1,8 @@
-# Dev Metrics in Readme
+# Dev Metrics in Readme [![Build Status](https://travis-ci.com/athul/waka-readme.svg?branch=master)](https://travis-ci.com/athul/waka-readme)
 
 ![Project Preview](https://user-images.githubusercontent.com/8397274/87243943-e6b45c00-c457-11ea-94c9-2aa0bf241be8.png)
 
-----
+---
 
 [WakaTime](https://wakatime.com) Weekly Metrics on your Profile Readme:
 
@@ -10,12 +10,12 @@
 
 1. You need to update the markdown file(.md) with 2 comments. You can refer [here](#update-your-readme) for updating it.
 2. You'll need a WakaTime API Key. You can get that from your WakaTime Account Settings
-    - You can refer [here](#new-to-wakatime), if you're new to WakaTime
+   - You can refer [here](#new-to-wakatime), if you're new to WakaTime
 3. **Optional** You'll need a GitHub API Token with `repo` scope from [here](https://github.com/settings/tokens) if you're running the action not in your Profile Repository
-    - You can use [this](#other-repository-not-profile) example to work it out
+   - You can use [this](#other-repository-not-profile) example to work it out
 4. You need to save the WakaTime API Key (and the GitHub API Token, if you need it) in the repository secrets. You can find that in the Settings of your Repository.Be sure to save those as the following.
-    - WakaTime-api-key as `WAKATIME_API_KEY = <your wakatime API Key>`and
-    - The GitHub Access Token as `GH_TOKEN=<your github access token>`
+   - WakaTime-api-key as `WAKATIME_API_KEY = <your wakatime API Key>`and
+   - The GitHub Access Token as `GH_TOKEN=<your github access token>`
 5. You can follow either of the Two Examples according to your needs to get started with.
 
 > I strongly suggest you to run the Action in your Profile Repo since you won't be needing a GitHub Access Token
@@ -44,7 +44,7 @@ WakaTime gives you an idea of the time you really spent on coding. This helps yo
 
 ### Profile Repository
 
-*If you're executing the workflow on your Profile Repository (`<username>/<username>`)*
+_If you're executing the workflow on your Profile Repository (`<username>/<username>`)_
 
 > You wouldn't need an GitHub Access Token since GitHub Actions already makes one for you.
 
@@ -52,40 +52,41 @@ Please follow the steps below:
 
 1. Go to your `<username>/<username>/actions`, hit `New workflow`, `set up a workflow yourself`, delete all the default content github made for you.
 2. Copy the following code and paste it to your new workflow you created at step 1:
-  ```yml
-  name: Waka Readme
 
-  on:
-    workflow_dispatch
-    schedule:
-      # Runs at 12am UTC
-      - cron: '0 0 * * *'
+```yml
+name: Waka Readme
 
-  jobs:
-    update-readme:
-      name: Update this repo's README
-      runs-on: ubuntu-latest
-      steps:
-        - uses: athul/waka-readme@master
-          with:
-            WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
-  ```
-3. Go to your repo secrets by hitting `Settings => Secrets` tab in your profile repo. You can also enter the url  https://github.com/USERNAME/USERNAME/settings/secrets . Please replace the `USERNAME` with your own username.
-4. Create a new `Secret`. `Name`: `WAKATIME_API_KEY`, `Value`: Paste the Wakatime API key here. If you don't know what is the key, please go to  [Account Settings in WakaTime](https://wakatime.com/settings/account) to find your API Key there.
+on:
+  workflow_dispatch:
+  schedule:
+    # Runs at 12am UTC
+    - cron: "0 0 * * *"
+
+jobs:
+  update-readme:
+    name: Update this repo's README
+    runs-on: ubuntu-latest
+    steps:
+      - uses: athul/waka-readme@master
+        with:
+          WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
+```
+
+3. Go to your repo secrets by hitting `Settings => Secrets` tab in your profile repo. You can also enter the url https://github.com/USERNAME/USERNAME/settings/secrets . Please replace the `USERNAME` with your own username.
+4. Create a new `Secret`. `Name`: `WAKATIME_API_KEY`, `Value`: Paste the Wakatime API key here. If you don't know what is the key, please go to [Account Settings in WakaTime](https://wakatime.com/settings/account) to find your API Key there.
 5. Add a comment to your `README.md` like this:
 
-  ```md
-  <!--START_SECTION:waka-->
-  <!--END_SECTION:waka-->
-  ```
+```md
+<!--START_SECTION:waka-->
+<!--END_SECTION:waka-->
+```
+
 6. Go to Workflows menu (mentioned in step 1), click `Waka Readme`, click `Run workflow`.
-7. Go to your profile page. you will be able to see it. 
+7. Go to your profile page. you will be able to see it.
 
 ### Other Repository (not Profile)
 
-
-
-*If you're executing the workflow on another repo other than `<username>/<username>`*
+_If you're executing the workflow on another repo other than `<username>/<username>`_
 
 You'll need to get a [GitHub Access Token](https://docs.github.com/en/actions/configuring-and-managing-workflows/authenticating-with-the-github_token) with a `repo` scope and save it in the Repo Secrets `GH_TOKEN = <Your GitHub Access Token>`
 
@@ -97,7 +98,7 @@ name: Waka Readme
 on:
   schedule:
     # Runs at 12am UTC
-    - cron: '0 0 * * *'
+    - cron: "0 0 * * *"
 
 jobs:
   update-readme:
@@ -108,9 +109,25 @@ jobs:
         with:
           WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
           GH_TOKEN: ${{ secrets.GH_TOKEN }}
-          USERNAME: <username> # optional, it will automatically use the username of the owner of the repository who's executing the workflow.
+          REPOSITORY: <username/username> # optional, By default, it will automatically use the repository who's executing the workflow.
 ```
 
+## Tests
+
+### Running Tests
+
+To run tests simply execute the following in the directory containing main.py:
+
+```python
+python -m unittest discover
+```
+
+### Contributing Tests
+
+These tests uses the python Unit testing framework, [unittest](https://docs.python.org/3/library/unittest.html)
+
+Since this project is contained all within one file, 'main.py'. You can simply add a function to the TestMain class in tests/test_main.py, similar to the test_graph function.
+
 ## Extras
 
 1. If you want to add the week in the Header of your stats, you can add `HEAD_FLAG: true` in your workflow file like this
@@ -120,7 +137,6 @@ jobs:
         with:
           WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
           GH_TOKEN: ${{ secrets.GH_TOKEN }}
-          USERNAME: <username>
           SHOW_TITLE: true
 ```
 
@@ -128,9 +144,44 @@ jobs:
 
 ```text
 Week: 10 July, 2020 - 17 July, 2020
-Python      8 hrs 52 mins       ███████████████████░░░░░░   75.87 % 
-Go          1 hr 15 mins        ██░░░░░░░░░░░░░░░░░░░░░░░   10.79 % 
-Markdown    52 mins             █░░░░░░░░░░░░░░░░░░░░░░░░   07.43 % 
-Docker      16 mins             ░░░░░░░░░░░░░░░░░░░░░░░░░   02.32 % 
+Python      8 hrs 52 mins       ███████████████████░░░░░░   75.87 %
+Go          1 hr 15 mins        ██░░░░░░░░░░░░░░░░░░░░░░░   10.79 %
+Markdown    52 mins             █░░░░░░░░░░░░░░░░░░░░░░░░   07.43 %
+Docker      16 mins             ░░░░░░░░░░░░░░░░░░░░░░░░░   02.32 %
 YAML        7 mins              ░░░░░░░░░░░░░░░░░░░░░░░░░   01.07 %
 ```
+
+2. You can specify a commit message to override the default _"Updated the Graph with new Metrics"_. Here is how you do it
+
+```yml
+- uses: athul/waka-readme@master
+        with:
+          WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
+          GH_TOKEN: ${{ secrets.GH_TOKEN }}
+          COMMIT_MESSAGE: Updated the Readme
+```
+
+If no commit message is specified in the `yml` file, it defaults to _"Updated the Graph with new Metrics"_
+
+3. You can change the block characters to match with the style of your readme. By default the one show in the graphs before is used. Here is how you do it
+
+```yml
+- uses: athul/waka-readme@master
+        with:
+          WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
+          BLOCKS: ⣀⣄⣤⣦⣶⣷⣿
+```
+
+This will change the graphs to something like this:
+
+```text
+Python      8 hrs 52 mins       ⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣿⣀⣀⣀⣀⣀⣀   75.87 %
+Go          1 hr 15 mins        ⣿⣿⣦⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀   10.79 %
+Markdown    52 mins             ⣿⣿⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀   07.43 %
+Docker      16 mins             ⣤⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀   02.32 %
+YAML        7 mins              ⣄⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀⣀   01.07 %
+```
+
+## Why only the language stats and not other data from the API?
+
+I am a fan of minimal designs and the profile readme is a great way to show off your skills and interests. The WakaTime API, gets us a **lot of data** about a person's **coding activity including the editors and Operating Systems you used and the projects you worked on**. Some of these projects maybe secretive and should not be shown out to the public. Using up more data via the Wakatime API will clutter the profile readme and hinder your chances on displaying what you provide **value to the community** like the pinned Repositories. I believe that **Coding Stats is nerdiest of all** since you can tell the community that you are _**exercising these languages or learning a new language**_, this will also show that you spend some amount of time to learn and exercise your development skills. That's what matters in the end :heart:

action.yml

@@ -1,20 +1,20 @@
-name: 'Waka - Readme'
+name: "Waka - Readme"
 author: Athil Cyriac Ajay
-description: 'Add a Wakatime Coding Activity graph in your Readme'
+description: "Add a Wakatime Coding Activity graph in your Readme"
 
 inputs:
   GH_TOKEN:
-    description: 'GitHub access token with Repo scope'
+    description: "GitHub access token with Repo scope"
     required: true
     default: ${{ github.token }}
 
   WAKATIME_API_KEY:
-    description: 'Your Wakatime API Key'
+    description: "Your Wakatime API Key"
     required: true
 
-  USERNAME:
-    description: 'Your GitHub username'
-    default: ${{ github.repository_owner }}
+  REPOSITORY:
+    description: "Your GitHub repository"
+    default: ${{ github.repository }}
     required: false
 
   SHOW_TITLE:
@@ -22,11 +22,20 @@ inputs:
     default: false
     required: false
 
+  COMMIT_MESSAGE:
+    description: "Add a commit message of your choice"
+    default: "Updated the Graph with new Metrics"
+    required: false
+
+  BLOCKS:
+    description: "Add the progress blocks of your choice"
+    default: "░▒▓█"
+    required: false
 
 runs:
-  using: 'docker'
-  image: 'Dockerfile'
+  using: "docker"
+  image: "Dockerfile"
 
 branding:
-  icon: 'info'
-  color: 'blue'
+  icon: "info"
+  color: "blue"

main.py

@@ -14,10 +14,12 @@ START_COMMENT = '<!--START_SECTION:waka-->'
 END_COMMENT = '<!--END_SECTION:waka-->'
 listReg = f"{START_COMMENT}[\\s\\S]+{END_COMMENT}"
 
-user = os.getenv('INPUT_USERNAME')
+repository = os.getenv('INPUT_REPOSITORY')
 waka_key = os.getenv('INPUT_WAKATIME_API_KEY')
 ghtoken = os.getenv('INPUT_GH_TOKEN')
 show_title = os.getenv("INPUT_SHOW_TITLE")
+commit_message = os.getenv("INPUT_COMMIT_MESSAGE")
+blocks = os.getenv("INPUT_BLOCKS")
 
 
 def this_week() -> str:
@@ -28,12 +30,15 @@ def this_week() -> str:
     return f"Week: {week_start.strftime('%d %B, %Y')} - {week_end.strftime('%d %B, %Y')}"
 
 
-def make_graph(percent: float) -> str:
+def make_graph(percent: float, blocks: str) -> str:
     '''Make progress graph from API graph'''
-    done_block = '█'
-    empty_block = '░'
-    pc_rnd = round(percent)
-    return f"{done_block*int(pc_rnd/4)}{empty_block*int(25-int(pc_rnd/4))}"
+    graph = blocks[len(blocks)-1] * int(percent / 4 + 1 / 6)
+    remainder_block = int((percent + (len(blocks)-2) /
+                           (len(blocks)-1)) % 4 * (len(blocks)-1) / len(blocks))
+    if remainder_block > 0:
+        graph += blocks[remainder_block]
+    graph += blocks[0] * (25 - len(graph))
+    return graph
 
 
 def get_stats() -> str:
@@ -53,14 +58,16 @@ def get_stats() -> str:
         print("The Data seems to be empty. Please wait for a day for the data to be filled in.")
         return '```text\nNo Activity tracked this Week\n```'
     for lang in lang_data[:5]:
+        if lang['hours'] == 0 and lang['minutes'] == 0:
+            continue
         lth = len(lang['name'])
         ln_text = len(lang['text'])
         # following line provides a neat finish
         fmt_percent = format(lang['percent'], '0.2f').zfill(5)
         data_list.append(
-            f"{lang['name']}{' '*(pad + 3 - lth)}{lang['text']}{' '*(16 - ln_text)}{make_graph(lang['percent'])}   {fmt_percent} %")
+            f"{lang['name']}{' '*(pad + 3 - lth)}{lang['text']}{' '*(16 - ln_text)}{make_graph(lang['percent'], blocks)}   {fmt_percent} % ")
     print("Graph Generated")
-    data = ' \n'.join(data_list)
+    data = '\n'.join(data_list)
     if show_title == 'true':
         print("Stats with Weeks in Title Generated")
         return '```text\n'+this_week()+'\n\n'+data+'\n```'
@@ -70,7 +77,7 @@ def get_stats() -> str:
 
 
 def decode_readme(data: str) -> str:
-    '''Decode the contets of old readme'''
+    '''Decode the contents of old readme'''
     decoded_bytes = base64.b64decode(data)
     return str(decoded_bytes, 'utf-8')
 
@@ -84,14 +91,17 @@ def generate_new_readme(stats: str, readme: str) -> str:
 if __name__ == '__main__':
     g = Github(ghtoken)
     try:
-        repo = g.get_repo(f"{user}/{user}")
+        repo = g.get_repo(repository)
     except GithubException:
         print("Authentication Error. Try saving a GitHub Token in your Repo Secrets or Use the GitHub Actions Token, which is automatically used by the action.")
         sys.exit(1)
+    if len(blocks) < 1:
+        print("Invalid blocks string. Please provide provide a string with 2 or more characters. Eg. '░▒▓█'")
+        sys.exit(1)
     contents = repo.get_readme()
     waka_stats = get_stats()
     rdmd = decode_readme(contents.content)
     new_readme = generate_new_readme(stats=waka_stats, readme=rdmd)
     if new_readme != rdmd:
-        repo.update_file(path=contents.path, message='Updated with Dev Metrics',
-                         content=new_readme, sha=contents.sha, branch='master')
+        repo.update_file(path=contents.path, message=commit_message,
+                         content=new_readme, sha=contents.sha)

tests/test_main.py

@@ -0,0 +1,50 @@
+'''
+Tests for the main.py
+'''
+from main import make_graph
+import unittest
+import os
+
+
+class TestMain(unittest.TestCase):
+
+    def test_make_graph(self):
+        '''Tests the make_graph function'''
+        def test(percent: float, block: str, result: str):
+            self.assertEqual(make_graph(percent, block), result,
+                             f"{percent}% should return {result}")
+        blocks = ["░▒▓█", "⚪⚫"]
+        percents = [0, 100, 50, 50.001, 25, 75, 3.14,
+                    9.901, 87.334, 87.333, 4.666, 4.667]
+        graphGroup = [["░░░░░░░░░░░░░░░░░░░░░░░░░",
+                       "█████████████████████████",
+                       "████████████▒░░░░░░░░░░░░",
+                       "████████████▓░░░░░░░░░░░░",
+                       "██████▒░░░░░░░░░░░░░░░░░░",
+                       "██████████████████▓░░░░░░",
+                       "▓░░░░░░░░░░░░░░░░░░░░░░░░",
+                       "██▒░░░░░░░░░░░░░░░░░░░░░░",
+                       "██████████████████████░░░",
+                       "█████████████████████▓░░░",
+                       "█░░░░░░░░░░░░░░░░░░░░░░░░",
+                       "█▒░░░░░░░░░░░░░░░░░░░░░░░"],
+                      ["⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪",
+                       "⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫",
+                       "⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪",
+                       "⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪",
+                       "⚫⚫⚫⚫⚫⚫⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪",
+                       "⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚪⚪⚪⚪⚪⚪",
+                       "⚫⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪",
+                       "⚫⚫⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪",
+                       "⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚪⚪",
+                       "⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚫⚪⚪⚪",
+                       "⚫⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪",
+                       "⚫⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪⚪"]]
+        for i, graphs in enumerate(graphGroup):
+            os.environ["INPUT_BLOCKS"] = blocks[i]
+            for j, graph in enumerate(graphs):
+                test(percents[j], blocks[i], graph)
+
+
+if __name__ == '__main__':
+    unittest.main()