Merge pull request #6 from joe733/master

feat: Added week #number to dev metrics

README.md

@@ -1,32 +1,54 @@
 # Dev Metrics in Readme
 
-[Wakatime](https://wakatime.com) Weekly Metrics on your Profile 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:
+
+## Prep Work
+
+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
+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
+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>`
+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
+
+This Action will run everyday at 00.00 UTC
+
 ## Update your Readme
 
-Add a comment to your README like the follows
+Add a comment to your `README.md` like this:
 
 ```md
 <!--START_SECTION:waka-->
 <!--END_SECTION:waka-->
 ```
 
-The lines will be our entrypoints for our metrics.
+These lines will be our entry-points for the dev metrics.
 
-## Using it
+## New to WakaTime
 
-- Get your Wakatime API Key from your [Account Settings in Wakatime](https://wakatime.com/settings/account) and save it as `WAKATIME_API_KEY = <your wakatime API Key>` in your Repository Secrets
+WakaTime gives you an idea of the time you really spent on coding. This helps you boost your productivity and competitive edge.
 
-That's it. The Action runs everyday at 00.00 UTC
+- Head over to <https://wakatime.com> and create an account.
+- Get your WakaTime API Key from your [Account Settings in WakaTime](https://wakatime.com/settings/account).
+- Install the [WakaTime plugin](https://wakatime.com/plugins) in your favourite editor / IDE.
+- Paste in your API key to start the analysis.
 
 ### 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.**
+> You wouldn't need an GitHub Access Token since GitHub Actions already makes one for you.
 
-Here is a sample workflow file for you to get started,
+Here is a sample workflow file for you to get started:
 
 ```yml
 name: Waka Readme
@@ -46,13 +68,13 @@ jobs:
           WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
 ```
 
-### Different Repository than Profile Repository
+### 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 with a `repo` scope and save it in the Repo Secrets `GH_TOKEN = <Your GitHub Access Token>`
+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>`
 
-Here is Sample Worflow File for running it
+Here is Sample Workflow File for running it:
 
 ```yml
 name: Waka Readme
@@ -70,6 +92,6 @@ jobs:
       - uses: athul/waka-readme@master
         with:
           WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
-          GH_TOKEN: ${{ secrets.GH_TOKEN}}
-          USERNAME: <username> # optional, it will automaticially use the username that executing the workflow
+          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.
 ```

main.py

@@ -1,26 +1,41 @@
-import base64
-import requests
+'''
+WakaTime progress visualizer
+'''
+
 import re
 import os
+import base64
+import datetime
+import requests
 from github import Github
 
+
 START_COMMENT = '<!--START_SECTION:waka-->'
 END_COMMENT = '<!--END_SECTION:waka-->'
-listReg = f'{START_COMMENT}[\\s\\S]+{END_COMMENT}'
+listReg = f"{START_COMMENT}[\\s\\S]+{END_COMMENT}"
 
-user = os.getenv("INPUT_USERNAME")
-waka_key = os.getenv("INPUT_WAKATIME_API_KEY")
-ghtoken = os.getenv("INPUT_GH_TOKEN")
+user = os.getenv('INPUT_USERNAME')
+waka_key = os.getenv('INPUT_WAKATIME_API_KEY')
+ghtoken = os.getenv('INPUT_GH_TOKEN')
 
+def this_week():
+    '''Returns current week span'''
+    week_number = datetime.date.today().isocalendar()[1]
+    month = datetime.date.today().strftime('%B')
+    week_start = datetime.datetime.today().day - datetime.datetime.today().weekday()
+    week_end = week_start + 5
+    return f"Week #{week_number} : {month} {week_start} - {week_end}"
 
-def makeGraph(percent: float):
-    done_block = "█"
-    empty_block = "░"
+def make_graph(percent: float):
+    '''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))}')
+    return f"{done_block*int(pc_rnd/4)}{empty_block*int(25-int(pc_rnd/4))}"
 
 
-def getStats():
+def get_stats():
+    '''Gets API data and returns markdown progress'''
     data = requests.get(
         f"https://wakatime.com/api/v1/users/current/stats/last_7_days?api_key={waka_key}").json()
     lang_data = data['data']['languages']
@@ -28,31 +43,31 @@ def getStats():
     for l in lang_data[:5]:
         ln = len(l['name'])
         ln_text = len(l['text'])
-        op = f"{l['name']}{' '*(12-ln)}{l['text']}{' '*(20-ln_text)}{makeGraph(l['percent'])}   {l['percent']}"
+        op = f"{l['name']}{' '*(12-ln)}{l['text']}{' '*(20-ln_text)}{make_graph(l['percent'])}   {l['percent']}%"
         data_list.append(op)
-    data = " \n".join(data_list)
-    return ("```text\n"+data+"\n```")
+    data = ' \n'.join(data_list)
+    return '```text\n'+this_week()+'\n\n'+data+'\n```'
 
 
-def decodeReadme(data: str):
-    decodedBytes = base64.b64decode(data)
-    decodedStr = str(decodedBytes, "utf-8")
-    return decodedStr
+def decode_readme(data: str):
+    '''Decode the contets of old readme'''
+    decoded_bytes = base64.b64decode(data)
+    return str(decoded_bytes, 'utf-8')
 
 
-def generatenewReadme(stats: str, readme: str):
-    statsinReadme = f"{START_COMMENT}\n{stats}\n{END_COMMENT}"
-    newReadme = re.sub(listReg, statsinReadme, readme)
-    return newReadme
+def generate_new_readme(stats: str, readme: str):
+    '''Generate a new Readme.md'''
+    stats_in_readme = f"{START_COMMENT}\n{stats}\n{END_COMMENT}"
+    return re.sub(listReg, stats_in_readme, readme)
 
 
 if __name__ == '__main__':
     g = Github(ghtoken)
     repo = g.get_repo(f"{user}/{user}")
     contents = repo.get_readme()
-    stats = getStats()
-    rdmd = decodeReadme(contents.content)
-    newreadme = generatenewReadme(stats=stats, readme=rdmd)
-    if newreadme != rdmd:
-        repo.update_file(path=contents.path, message="Updated with Dev Metrics",
-                     content=newreadme, sha=contents.sha, branch="master")
+    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')