[!IMPORTANT]
We are looking for translators for this project.
Any kind of help would be greatly appreciated.
Please see issue https://github.com/anmol098/waka-readme-stats/issues/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
- 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 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.
- 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>
- 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.
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.
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_AI_CODE_TIME and SHOW_AI_CODING flags below require WakaTime’s AI coding tracking to be recording activity on your account. If your account has no all-time AI data the AI Code Time badge is hidden entirely; if it has no AI data for the current week, the weekly block still shows with a “No AI Coding Activity Tracked This Week” message instead of numbers.
The SHOW_AI_CODE_TIME flag can be set to False to hide the all-time AI Code Time badge.
The SHOW_AI_CODING flag can be set to False to hide the weekly AI coding breakdown: AI coding time, AI vs. human written lines, token usage, estimated AI cost, sessions/prompts, a per-model breakdown, and a few deduced insights.
🤖 AI Coding This Week
⏱ AI Coding Time: 1 hr 53 mins (3.59%)
✍️ 1,245 lines written by AI, 3,120 lines written by hand (28.52% AI-written)
🔤 845,000 Input Tokens, 21,000 Output Tokens
💵 $12.48 Estimated AI Cost This Week
🧠 5 AI Sessions, 20 AI Prompts
Sonnet 1,200 lines ██████████████████████░░░ 89.96 %
GPT-4 134 lines ███░░░░░░░░░░░░░░░░░░░░░░ 10.04 %
🔎 AI Coding Insights:
🧑💻 Mostly Hands-On — 28.52% of written lines came from AI
📄 Detailed Prompter — average 925 characters per prompt
🔁 Iterative Prompter — average 4 prompts per session
🔍 Hands-On Reviewer — 73.29% of changed lines were hand-edited
The insight lines are all deduced from the raw numbers above, not extra API data:
- AI Reliance (
🤖 AI-Driven / ⚖️ Balanced with AI / 🧑💻 Mostly Hands-On) — from the share of added lines written by AI.
- Prompt Style (
📝 Concise / 📄 Detailed / 📚 Verbose) — from the average prompt length.
- Session Style (
🎯 One-Shot / 🔁 Iterative) — from the average number of prompts per AI session, i.e. whether you tend to get it right in one prompt or rely on follow-ups.
- Review Style (
🔍 Hands-On Reviewer / 🚀 High AI Trust) — from the share of all changed lines that were still hand-edited, as a proxy for how much AI output gets manually reviewed/reworked.
If there was no AI coding activity that week, the block still renders with a fallback message instead of disappearing:
No AI Coding Activity Tracked This Week
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.
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 MAX_REPOS flag can be set to limit how many GitHub repositories are fetched for analysis (default: 0 = unlimited). This can be useful to speed up runs for accounts with many repos.
If you see examples using MAX_CAP, that is a deprecated alias for MAX_REPOS.
The WAKATIME_API_URL flag can be set if you are hosting your own wakatime compliant backend like wakapi. You only have to supply your base url like so https://your-own-wakapi.dev/api/
The SYMBOL_VERSION flag can be set for the symbol for the progress bar (default: 1).
| Version |
Done block |
Empty block |
| 1 |
█ |
░ |
| 2 |
⣿ |
⣀ |
| 3 |
⬛ |
⬜ |
SVG Progress Bars
You can switch from Unicode text bars to colorful SVG bars with the following flags:
BAR_STYLE — Set to "svg" to enable SVG bars, or "text" (default) for Unicode barsBAR_COLOR — Hex color for the filled portion (default: "#90CAF9" light blue)BAR_TRACK_COLOR — Hex color for the background track (default: "#172f45" dark blue)BAR_RADIUS — Border radius for rounded corners (default: "0" for square)
"0" = Sharp square edges"4" = Subtle rounded corners- Any positive integer works
TEXT_PRIMARY_COLOR — Hex color for primary SVG list text such as language/project names (default: "#c9d1d9")TEXT_SECONDARY_COLOR — Hex color for secondary SVG list text such as times and percentages (default: "#8b949e")
Example workflow with SVG bars enabled:
- uses: anmol098/waka-readme-stats@master
with:
WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
GH_TOKEN: ${{ secrets.GH_TOKEN }}
BAR_STYLE: "svg"
BAR_COLOR: "#90CAF9"
BAR_TRACK_COLOR: "#172f45"
BAR_RADIUS: "4"
TEXT_PRIMARY_COLOR: "#c9d1d9"
TEXT_SECONDARY_COLOR: "#8b949e"
Before / after
Default Unicode bars (BAR_STYLE: "text", or omitting BAR_STYLE):
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%
SVG bars, square corners (BAR_STYLE: "svg", BAR_RADIUS: "0", default BAR_COLOR / BAR_TRACK_COLOR):
SVG bars, rounded corners (BAR_STYLE: "svg", BAR_RADIUS: "4"):
The DEBUG_LOGGING flag can be set to increase the GitHub Action’s output verbosity, The default is the internal runner’s debug property.
The BADGE_STYLE flag defines the style for the generated badges and can be set to flat, flat-square, plastic, for-the-badge, or social.
| Badge Style |
Preview |
flat |
 |
flat-square |
 |
plastic |
 |
for-the-badge |
 |
social |
 |
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:
- You can make one-time donations via PayPal. I’ll probably buy some 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
- Anmol Pratap Singh: Maintainer
- Alexander Sergeev: Maintainer
- DataBoySu: Maintainer
- okcoder1: Maintainer
- Aravind V. Nair: Maintainer
- Prabhat Singh: For code timeline graph #18
- Hedy Li: For Pull Request #34 and #23
- Pedro Torres: For Pull Request #29
- Aaron Meese: For Pull Request #45
- Arnav Jindal: For Pull Request #48
- Daniel Rowe: For Pull Request #57
- Ss5h: For adding support for natural sentence writing for translation #136
- acheronx0577: For adding SVG progress bar support with color and shape options #657
Special mention for those who are currently making their profile readme more awesome :smile: :tada:
- 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! :blush:
We will be glad to add you in the list.
Made with :heart: and Python 🐍.
Inspired From
Awesome Pinned Gists
athul/waka-readme
This project needs a star ⭐ from you ♥
Stargazers over time
![dependabot[bot]](https://avatars.githubusercontent.com/in/29110?v=4)
评论