https://github.com/anmol098/waka-readme-stats
This GitHub action helps to add cool dev metrics to your github profile Readme
https://github.com/anmol098/waka-readme-stats
awesome profile profile-page profile-readme readme wakatime
Last synced: 26 days ago
JSON representation
This GitHub action helps to add cool dev metrics to your github profile Readme
- Host: GitHub
- URL: https://github.com/anmol098/waka-readme-stats
- Owner: anmol098
- License: mit
- Created: 2020-07-19T14:29:40.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-08-05T08:23:17.000Z (8 months ago)
- Last Synced: 2024-10-29T21:00:14.547Z (6 months ago)
- Topics: awesome, profile, profile-page, profile-readme, readme, wakatime
- Language: Python
- Homepage:
- Size: 33.3 MB
- Stars: 3,335
- Watchers: 9
- Forks: 544
- Open Issues: 78
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- Awesome-GithubProfile-README - waka-readme-stats
- awesome - anmol098/waka-readme-stats - This GitHub action helps to add cool dev metrics to your github profile Readme (Python)
- awesome-github-profile - All Dev Stats in Readme - Are you an early ๐ค or a night ๐ฆ? When are you most productive during the day? What languages you code in? And other stuff... Let's check out in your readme! (Tools)
- awesome - anmol098/waka-readme-stats - This GitHub action helps to add cool dev metrics to your github profile Readme (Python)
- awesome-ccamel - anmol098/waka-readme-stats - This GitHub action helps to add cool dev metrics to your github profile Readme (Python)
- starred - anmol098/waka-readme-stats - This GitHub action helps to add cool dev metrics to your github profile Readme (Python)
- awesome-readme-tools - Waka Readme Stats - GitHub action helps to add cool dev metrics to your github profile readme. (GitHub Actions for Readmes)
- awesome-github-profile-readme - All Dev Stats in Readme - Are you an early ๐ค or a night ๐ฆ? When are you most productive during the day? What languages you code in? And other stuff... Let's check out in your readme! (Tools)
- awesome-ubc-profile-readme - All Dev Stats in Readme - Are you an early ๐ค or a night ๐ฆ? When are you most productive during the day? What languages you code in? And other stuff... Let's check out in your readme! (Tools)
- jimsghstars - anmol098/waka-readme-stats - This GitHub action helps to add cool dev metrics to your github profile Readme (Python)
- awesome-bd-readme-profile - All Dev Stats in Readme - Are you an early ๐ค or a night ๐ฆ? When are you most productive during the day? What languages you code in? And other stuff... Let's check out in your readme! (Tools / Images Gifs:)
- awesome-bd-readme-profile - All Dev Stats in Readme - Are you an early ๐ค or a night ๐ฆ? When are you most productive during the day? What languages you code in? And other stuff... Let's check out in your readme! (Tools / Images Gifs:)
- fucking-awesome-github-profile-readme - All Dev Stats in Readme - Are you an early ๐ค or a night ๐ฆ? When are you most productive during the day? What languages you code in? And other stuff... Let's check out in your readme! (Tools)
- awesome-github-profile - waka readme stats
- AwesomeGithubProfileTemplates - All Dev Stats in Readme - Are you an early ๐ค or a night ๐ฆ? When are you most productive during the day? What languages you code in? And other stuff... Let's check out in your readme! (Resources / Tools)
- stars - waka-readme-stats
- stars - waka-readme-stats
- awesomeLibrary - waka-readme-stats - This GitHub action helps to add cool dev metrics to your github profile Readme. (่ฏญ่จ่ตๆบๅบ / python)
README
> Looking For Translation to different languages & Locale [#23](https://github.com/anmol098/waka-readme-stats/issues/23)
# 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!## 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. You'll need a GitHub API Token with `repo` and `user` scope from [here](https://github.com/settings/tokens) if you're running the action to get commit metrics
> enabling the `repo` scope seems **DANGEROUS**
> but this GitHub Action only accesses your commit timestamp and lines of code added or deleted in repository you contributed.
- You can use [this](#profile-repository) example to work it out
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=`
- GitHub Personal Access Token as `GH_TOKEN=`
5. 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:
```md
```
`waka` can be replaced by any string specified in the `SECTION_NAME` flag as per (the available flags section)[#flags-available]
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 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
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` and `user` scope and save it in the Repo Secrets `GH_TOKEN = `
Here is Sample Workflow File for running it:
```yml
name: Waka Readmeon:
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 run automatically, but you can also trigger to run it to see the result now. Just go to the `Actions` in your repo and select your `Profile Readme Development Stats` workflow and click in `Run workflow`. Now wait for a minute or two and you will see your changes.## Extras
1. 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```yml
- 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 uses Locale [Short Hand](https://saimana.com/list-of-country-locale-code/) to be passed in the flag variable example of the final result can be found [here](https://github.com/anmol098/anmol098/blob/master/Readme-fr.md)
`SECTION_NAME` flag can be set to any string, and will be the name of the section to replace in the readme
`COMMIT_BY_ME` flag can be set to `True` to commit the code using your name and email
`COMMIT_MESSAGE` flag can be set to message commit, default is "Updated with Dev Metrics"
`COMMIT_USERNAME` flag can be set to username to commit the code, default is "readme-bot"
`COMMIT_EMAIL` flag can be set to email to commit the code, default is "41898282+github-actions[bot]@users.noreply.github.com"
`SHOW_UPDATED_DATE` flag can be set to `True` to show updated date in end of paragraph
`UPDATED_DATE_FORMAT` flag can be set to put updated date into a format, default is `"%d/%m/%Y %H:%M:%S"`
`SHOW_LINES_OF_CODE` flag can be set to `True` to show the Lines of code writen till date

`SHOW_TOTAL_CODE_TIME` flag can be set to `False` to hide *Code Time*

`SHOW_PROFILE_VIEWS` flag can be set to `False` to hide the Profile views

`SHOW_COMMIT` flag can be set to `False` to hide the commit stats
**I'm an early ๐ค**
```text
๐ Morning 95 commits โโโโโโโโโโโโโโโโโโโโโโโโโ 30.55%
๐ Daytime 78 commits โโโโโโโโโโโโโโโโโโโโโโโโโ 25.08%
๐ Evening 112 commits โโโโโโโโโโโโโโโโโโโโโโโโโ 36.01%
๐ Night 26 commits โโโโโโโโโโโโโโโโโโโโโโโโโ 8.36%```
`SHOW_DAYS_OF_WEEK` flag can be set to `False` to hide the commits made on different days of week
๐ **I'm Most Productive on Sundays**
```text
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
```text
๐ฌ 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
```text
๐ป Operating Systems:
Windows 8 hrs 46 mins โโโโโโโโโโโโโโโโโโโโโโโโโ 100.0%
````SHOW_PROJECTS` flag can be set to `False` to hide the Projects worked on
```text
๐ฑโ๐ป 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
```text
โ๏ธ Timezone: Asia/Calcutta
````SHOW_EDITORS` flag can be set to `False` to hide the list of code-editors used
```text
๐ฅ Editors:
WebStorm 6 hrs 47 mins โโโโโโโโโโโโโโโโโโโโโโโโโ 77.43%
PhpStorm 1 hr 35 mins โโโโโโโโโโโโโโโโโโโโโโโโโ 18.07%
PyCharm 23 mins โโโโโโโโโโโโโโโโโโโโโโโโโ 4.49%
````SHOW_LANGUAGE_PER_REPO` flag can be set to `False` to hide the Number of repository in different language and frameworks
**I mostly code in Vue**
```text
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%```
`SHOW_SHORT_INFO` flag can be set to `False` to hide the short fun fact info of user
>This section requires personal access token with user permission otherwise data shown will be incorrect here**๐ฑ 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`SHOW_LOC_CHART` flag can be set to `False` to hide the Lines of code written in different quarters of different year
`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
`SYMBOL_VERSION` flag can be set symbol for progress bar (default: `1`)
| Version | Done block | Empty block |
|-------- | ---------- | ----------- |
| 1 | โ | โ |
| 2 | โฃฟ | โฃ |
| 3 | โฌ | โฌ |`DEBUG_LOGGING` flag can be set to increase action output verbosity, by default equals internal runner debug property
**Timeline**

## :sparkling_heart: 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 :rocket:
- [](https://www.paypal.me/aapreneur) - You can make one-time donations via PayPal. I'll probably buy a ~~beer~~ wine ๐ทThanks! :heart:
---
# 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](https://github.com/anmol098): Maintainer
2. [Alexander Sergeev](https://github.com/pseusys): Maintainer
3. [Aravind V. Nair](https://github.com/aravindvnair99): Maintainer
4. [Prabhat Singh](https://github.com/prabhatdev): For code timeline graph [#18](https://github.com/anmol098/waka-readme-stats/pull/18)
5. [Hedy Li](https://github.com/hedythedev): For Pull Request [#34](https://github.com/anmol098/waka-readme-stats/pull/34) and [#23](https://github.com/anmol098/waka-readme-stats/pull/23)
6. [Pedro Torres](https://github.com/Corfucinas): For Pull Request [#29](https://github.com/anmol098/waka-readme-stats/pull/29)
7. [Aaron Meese](https://github.com/ajmeese7): For Pull Request [#45](https://github.com/anmol098/waka-readme-stats/pull/45)
8. [Arnav Jindal](https://github.com/Daggy1234): For Pull Request [#48](https://github.com/anmol098/waka-readme-stats/pull/48)
9. [Daniel Rowe](https://github.com/DanRowe): For Pull Request [#57](https://github.com/anmol098/waka-readme-stats/pull/57)
10. [Ss5h](https://github.com/tlatkdgus1): For adding support for natural sentence writing for translation [#136](https://github.com/anmol098/waka-readme-stats/pull/136)Special mention for those who are currently making their profile readme more awesome :smile: :tada:
- [Stanislas](https://github.com/angristan)
- [Pratik Kumar](https://github.com/pr2tik1)
- [Vladimir](https://github.com/sergeev-vn)- [Pedro Torres](https://github.com/Corfucinas)
- [leverglowh](https://github.com/leverglowh)
- [patdc](https://github.com/patdc)
- [ๆๅฎขๆๆๆบ](https://github.com/meteor1993)
- [Fan()](https://github.com/Fanduzi)
- [Miller Camilo Vega](https://github.com/minoveaz)
- [XLor](https://github.com/yjl9903)
- [Jesse Okeya](https://github.com/jesseokeya)
- [anaiel](https://github.com/anaiel)
- [Dipto Mondal](https://github.com/diptomondal007)
- [Jerry F. Zhang](https://github.com/JerryFZhang)
- [Karan Singh](https://github.com/karan06126)
- [Erwin Lejeune](https://github.com/guilyx)
- [Manuel Cepeda](https://github.com/mecm1993)
- [Jonathan S](https://github.com/TGTGamer)
- [Tsotne Gvadzabia](https://github.com/RockiRider)
- [Miray](https://github.com/MirayXS)
- [Varad Patil](https://github.com/varadp2000)
- [Prabhat Singh](https://github.com/prabhatdev)
- [Nikhil](https://github.com/nikhilgorantla)
- [ๅคง็ฝ](https://github.com/2720851545)
- [Du Yizhuo](https://github.com/dyzdyz010)
- [Manas Talukdar](https://github.com/manastalukdar)
- [Simranjeet Singh](https://github.com/smrnjeet222)
- [Aaron Meese](https://github.com/ajmeese7)
- [Prasad Narkhede](https://github.com/p014ri5)
- [Manish Kushwaha](https://github.com/tzmanish)
- [Hedy Li](https://github.com/hedythedev)
- [SHIMIZU Taku](https://github.com/takuan-osho)
- [Jude Wilson](https://github.com/mr-winson)
- [Daniel Rowe](https://github.com/DanRowe)
- [Muhammad Hassan Ahmed](https://github.com/hassan11196)
- [Alessandro Maggio](https://github.com/Tkd-Alex)
- [Siddharth Gupta](https://github.com/siddg97)
- [Dev-Mehta](https://github.com/Dev-Mehta/)
- [> EdgyCoder โ](https://github.com/edgycoder)
- [Korel Kashri](https://github.com/korelkashri)
- [Gustavo Barbosa](https://github.com/gusbdev)- [eagleanurag](https://github.com/eagleanurag)
- [Aravind V. Nair](https://github.com/aravindvnair99)
- [Raman Preet Singh](https://github.com/raman08)
- [Hayat Tamboli](https://github.com/hayat-tamboli)
- [Henry Boisdequin](https://github.com/henryboisdequin)
- [Raman Preet Singh](https://github.com/raman08)
- [Aadit Kamat](https://github.com/aaditkamat)
- [Subhalingam D](https://github.com/subhalingamd)
- [Adil Akhmetov](https://github.com/weeebdev)
- [Isaac Maldonado](https://github.com/einjunge99)
- [Syed Faateh Sultan Kazmi](https://github.com/faatehsultan)- [Shreyam Maity](https://github.com/ShreyamMaity)
- [Sufiane](https://github.com/sufiane)
- [Muhammad Bilal](https://github.com/BilalJaved15)
- [Waterdev](https://github.com/UnrealValentin)
- [Aditya Prasad S](https://github.com/adityaprasad502)
- [C. Vinicius Santos](https://github.com/c-viniciussantos)
- [James Tufarelli](https://github.com/Minituff)
- [Muhammad Bilal](https://github.com/BilalJaved15)- [Wyatt Walsh](https://www.github.com/wyattowalsh)
- [Nithin Balaji](https://github.com/thenithinbalaji)
- 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](https://github.com/anmol098/waka-readme-stats/issues/new/choose) issue :blush: we are glad to add you in the list.
Made with :heart: and Python ๐.
# Inspired From
> [Awesome Pinned Gists](https://github.com/matchai/awesome-pinned-gists)
> [athul/waka-readme](https://github.com/athul/waka-readme)### This project need a **star** โญ from you โฅ.
## Stargazers over time
[](https://starchart.cc/anmol098/waka-readme-stats)