Files

Anmol Pratap Singh fc788c01f9 Update README.md

2020-07-27 20:27:26 +05:30

9.0 KiB

Raw Blame History

Dev Metrics in Readme with added feature flags 🎌

📌✨Awesome Readme Stats

Are you an early 🐤 or a night 🦉?
When are you most productive during the day?
What are languages you code in?
Let's check out in your profile readme!

Report Bug · Request Feature

Prep Work

You need to update the markdown file(.md) with 2 comments. You can refer here for updating it.
You'll need a WakaTime API Key. You can get that from your WakaTime Account Settings
- You can refer here, if you're new to WakaTime
You'll need a GitHub API Token with repo scope from here if you're running the action to get commit metrics

enable repo scope seems DANGEROUS
but this GitHub Action only accesses your commit timestamp in repository you contributed.
- You can use this example to work it out
You need to save the WakaTime API Key and the GitHub API Token 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>
You can enable and disable feature flags based on requirements.

This Action will run everyday at 00.00 IST

Update your Readme

Add a comment to your README.md like this:

<!--START_SECTION:waka-->
<!--END_SECTION:waka-->

These lines will be our entry-points for the dev metrics.

New to WakaTime

WakaTime gives you an idea of the time you really spent on coding. This helps you boost your productivity and competitive edge.

Head over to https://wakatime.com and create an account.
Get your WakaTime API Key from your Account Settings in WakaTime.
Install the WakaTime plugin in your favourite editor / IDE.
Paste in your API key to start the analysis.

Profile Repository

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>

Here is Sample Workflow File for running it:

name: Waka Readme

on:
  schedule:
    # Runs at 12am IST
    - cron: '30 18 * * *'

jobs:
  update-readme:
    name: Update Readme with Metrics
    runs-on: ubuntu-latest
    steps:
      - uses: anmol098/waka-readme-stats@master
        with:
          WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
          GH_TOKEN: ${{ secrets.GH_TOKEN }}

Extras

If you want to add the other info to your stats, you can add multiple FLAGS in your workflow file by default all flags are enabled

except the lines of code flag due to heavy operation performed

- uses: anmol098/waka-readme-stats@master
        with:
          WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
          GH_TOKEN: ${{ secrets.GH_TOKEN }}
          SHOW_OS: "False"
          SHOW_PROJECTS: "False"

Flags Available

SHOW_LINES_OF_CODE flag can be set to True to show the Lines of code writen till date

SHOW_COMMIT flag can be set to False to hide the commit stats

I'm an early 🐤

🌞 Morning    95 commits     ███████░░░░░░░░░░░░░░░░░░   30.55% 
🌆 Daytime    78 commits     ██████░░░░░░░░░░░░░░░░░░░   25.08% 
🌃 Evening    112 commits    █████████░░░░░░░░░░░░░░░░   36.01% 
🌙 Night      26 commits     ██░░░░░░░░░░░░░░░░░░░░░░░   8.36%

📅 I'm Most Productive on Sundays

Monday       50 commits     ███░░░░░░░░░░░░░░░░░░░░░░   13.19% 
Tuesday      85 commits     █████░░░░░░░░░░░░░░░░░░░░   22.43% 
Wednesday    56 commits     ███░░░░░░░░░░░░░░░░░░░░░░   14.78% 
Thursday     44 commits     ███░░░░░░░░░░░░░░░░░░░░░░   11.61% 
Friday       28 commits     █░░░░░░░░░░░░░░░░░░░░░░░░   7.39% 
Saturday     30 commits     ██░░░░░░░░░░░░░░░░░░░░░░░   7.92% 
Sunday       86 commits     █████░░░░░░░░░░░░░░░░░░░░   22.69%

SHOW_LANGUAGE flag can be set to False to hide the Coding Language You use

💬 Languages:
JavaScript               5 hrs 26 mins       ███████████████░░░░░░░░░░   61.97%
PHP                      1 hr 35 mins        ████░░░░░░░░░░░░░░░░░░░░░   18.07%
Markdown                 1 hr 9 mins         ███░░░░░░░░░░░░░░░░░░░░░░   13.3%
Python                   22 mins             █░░░░░░░░░░░░░░░░░░░░░░░░   4.32%
XML                      8 mins              ░░░░░░░░░░░░░░░░░░░░░░░░░   1.62%

SHOW_OS flag can be set to False to hide the OS details

💻 Operating Systems:
Windows                  8 hrs 46 mins       █████████████████████████   100.0%

SHOW_PROJECTS flag can be set to False to hide the Projects worked on

🐱‍💻 Projects:
ctx_connector            4 hrs 3 mins        ███████████░░░░░░░░░░░░░░   46.33%
NetSuite-Connector       1 hr 31 mins        ████░░░░░░░░░░░░░░░░░░░░░   17.29%
mango-web-master         1 hr 12 mins        ███░░░░░░░░░░░░░░░░░░░░░░   13.77%
cable                    54 mins             ██░░░░░░░░░░░░░░░░░░░░░░░   10.41%
denAPI                   40 mins             ██░░░░░░░░░░░░░░░░░░░░░░░   7.66%

SHOW_TIMEZONE flag can be set to False to hide the time zone you are in

⌚︎ Timezone: Asia/Calcutta

SHOW_EDITORS flag can be set to False to hide the list of code-editors used

🔥 Editors:
WebStorm                 6 hrs 47 mins       ███████████████████░░░░░░   77.43%
PhpStorm                 1 hr 35 mins        ████░░░░░░░░░░░░░░░░░░░░░   18.07%
PyCharm                  23 mins             █░░░░░░░░░░░░░░░░░░░░░░░░   4.49%

💖 Support the project

I open-source almost everything I can, and I try to reply to everyone needing help using these projects. Obviously, this takes time. You can use this service for free.

However, if you are using this project and happy with it or just want to encourage me to continue creating stuff, there are few ways you can do it :-

Giving proper credit when you use this action on your readme, linking back to it :D
Starring and sharing the project 🚀
- You can make one-time donations via PayPal. I'll probably buy a ~~beer~~ wine 🍷

Thanks! ❤️

Contributions are welcomed! ♥

Made with ❤️ and Python 🐍.

This project is inspired by an awesome pinned-gist project Awesome Pinned Gists
This project is inspired from athul/waka-readme

9.0 KiB Raw Blame History