Important

We are looking for translators for this project.
Any kind of help would be greatly appreciated.
Please see issue #23 if you would like to help!

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 the languages that you code in?
Let's check it out in your profile's README!

Report Bug · Request Feature

Prep Work

1. You need to update the markdown file(.md) with 2 comments. You can refer here for updating it.
2. 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.
3. You'll need a GitHub API Token with repo and user scope from here if you're running the action to get commit metrics.
   • You can use this example to work it out.

Note

Enabling the repo scope seems DANGEROUS,
but this GitHub Action only accesses your commit timestamps and the number of lines of code added or deleted in repositories that you contributed to.

4. 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>
   • GitHub Personal Access Token (PAT) as GH_TOKEN=<your github access token>
5. You can enable and disable feature flags based on your requirements.

This GitHub Action can be set to run at any time you want using cron. See Crontab.guru and this website to generate cron expressions.

Update your Readme

Add a comment to your README.md like this:

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

waka can be replaced by any string specified in the SECTION_NAME flag as per the available flags section.

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 and user scope and save it in the Repo Secrets GH_TOKEN = <Your GitHub Access Token>

Here is a sample workflow File for running it:

name: Waka Readme

on:
  schedule:
    # Runs at 12am IST
    - cron: '30 18 * * *'
  workflow_dispatch:
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 }}

• Now you can commit and wait for it to run automatically, or you can also trigger to run it to see the result now. Just go to the Actions in your repo, select your Profile Readme Development Stats workflow and click Run workflow. Now wait for a minute or two and you will see your changes.

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 the 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

---

LOCALE This flag can be used to show stats in your language. Default is English. Locale Short Hand to be passed in the flag variable. Example of the final result can be found here

The SECTION_NAME flag can be set to any string, and will be the name of the section to replace in the README.

The COMMIT_BY_ME flag can be set to True to commit the code using your name and email.

The COMMIT_MESSAGE flag can be set for the commit message. The default is "Updated with Dev Metrics"

The COMMIT_USERNAME flag can be set as a username to commit the code. The default is "readme-bot".

The COMMIT_EMAIL flag can be set to an email to commit the code. The default is "41898282+github-actions[bot]@users.noreply.github.com".

The SHOW_UPDATED_DATE flag can be set to True to show the updated date in end of paragraph.

The UPDATED_DATE_FORMAT flag can be set to put the updated date into a format. The default is "%d/%m/%Y %H:%M:%S".

The SHOW_LINES_OF_CODE flag can be set to True to show the number of lines of code writen till date.

The SHOW_TOTAL_CODE_TIME flag can be set to False to hide Code Time.

The SHOW_PROFILE_VIEWS flag can be set to False to hide Profile Views

The 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%

The SHOW_DAYS_OF_WEEK flag can be set to False to hide the commits made on the different days of the week.

📅 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%

The SHOW_LANGUAGE flag can be set to False to hide the programming languages 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%

The SHOW_OS flag can be set to False to hide your OS details.

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

The 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%

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

⌚︎ Timezone: Asia/Calcutta

The SHOW_EDITORS flag can be set to False to hide the list of code editors/IDEs used.

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

The SHOW_LANGUAGE_PER_REPO flag can be set to False to hide the number of repositories in different programming languages and frameworks.

I mostly code in Vue

Vue          8 repos        ██████░░░░░░░░░░░░░░░░░░░   25.0% 
Java         6 repos        ████░░░░░░░░░░░░░░░░░░░░░   18.75% 
JavaScript   6 repos        ████░░░░░░░░░░░░░░░░░░░░░   18.75% 
PHP          3 repos        ██░░░░░░░░░░░░░░░░░░░░░░░   9.38% 
Python       2 repos        █░░░░░░░░░░░░░░░░░░░░░░░░   6.25% 
Dart         2 repos        █░░░░░░░░░░░░░░░░░░░░░░░░   6.25% 
CSS          2 repos        █░░░░░░░░░░░░░░░░░░░░░░░░   6.25%

The SHOW_SHORT_INFO flag can be set to False to hide the short fun fact info of a user.

Note

This section requires a Personal Access Token (PAT) with the user scope, otherwise the data shown here will be incorrect.

🐱 My GitHub Data

🏆 433 Contributions in year 2020

📦 Used 292.3 kB in GitHub's Storage

💼 Opted to Hire

📜 25 Public Repository

🔑 15 Owned Private Repository

The SHOW_LOC_CHART flag can be set to False to hide the lines of code written in different quarters of different years.

The IGNORED_REPOS flag can be set to "waka-readme-stats, my-first-repo" (just an example) to ignore some repos you don’t want to be counted.

The SYMBOL_VERSION flag can be set for the symbol for the progress bar (default: 1).

Version	Done block	Empty block
1	█	░
2	⣿	⣀
3	⬛	⬜

The DEBUG_LOGGING flag can be set to increase the GitHub Action's output verbosity, by default equals internal runner debug property

Timeline

💖 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 some beer wine 🍷.

Thanks! ❤️

---

Contributing

Contributions are welcome ♥! Please share any features, and add unit tests! Use the pull request and issue systems to contribute.

Selected Contributors

1. Anmol Pratap Singh: Maintainer
2. Alexander Sergeev: Maintainer
3. Aravind V. Nair: Maintainer
4. Prabhat Singh: For code timeline graph #18
5. Hedy Li: For Pull Request #34 and #23
6. Pedro Torres: For Pull Request #29
7. Aaron Meese: For Pull Request #45
8. Arnav Jindal: For Pull Request #48
9. Daniel Rowe: For Pull Request #57
10. Ss5h: For adding support for natural sentence writing for translation #136

Special mention for those who are currently making their profile readme more awesome 😄 🎉

• Stanislas

• Pratik Kumar

• Vladimir

• Pedro Torres

• leverglowh

• patdc

• 极客挖掘机

• Fan()

• Miller Camilo Vega

• XLor

• Jesse Okeya

• anaiel

• Dipto Mondal

• Jerry F. Zhang

• Karan Singh

• Erwin Lejeune

• Manuel Cepeda

• Jonathan S

• Tsotne Gvadzabia

• Miray

• Varad Patil

• Prabhat Singh

• Nikhil

• 大白

• Du Yizhuo

• Manas Talukdar

• Simranjeet Singh

• Aaron Meese

• Prasad Narkhede

• Manish Kushwaha

• Hedy Li

• SHIMIZU Taku

• Jude Wilson

• Daniel Rowe

• Muhammad Hassan Ahmed

• Alessandro Maggio

• Siddharth Gupta

• Dev-Mehta

• > EdgyCoder ✌

• Korel Kashri

• Gustavo Barbosa

• eagleanurag

• Aravind V. Nair

• Raman Preet Singh

• Hayat Tamboli

• Henry Boisdequin

• Raman Preet Singh

• Aadit Kamat

• Subhalingam D

• Adil Akhmetov

• Isaac Maldonado

• Syed Faateh Sultan Kazmi

• Shreyam Maity

• Sufiane

• Muhammad Bilal

• Waterdev

• Aditya Prasad S

• C. Vinicius Santos

• James Tufarelli

• Muhammad Bilal

• Wyatt Walsh

• Nithin Balaji

• John Cortés

• Taha Parker

• Yang An Yi

• Mamdud Hasan

• Satyam Vyas

• Yash Naravade

• Luicen Loua

• And you! If ever you are using it right now and you are not on the list please tell us by sending a Special Mention issue! 😊
  We will be glad to add you in the list.

Made with ❤️ and Python 🐍.

Inspired From

Awesome Pinned Gists
athul/waka-readme

This project needs a star ⭐ from you ♥.

Stargazers over time