Skip to content
/ waka-readme-stats Public
forked from anmol098/waka-readme-stats

This GitHub action helps to add cool dev metrics to your github profile Readme

License

MIT license
0 stars 555 forks Branches Tags Activity
Star
Notifications You must be signed in to change notification settings

pasinduvinsuka/waka-readme-stats

BranchesTags
ย 
ย 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

ย 

History

698 Commits
.github
.github
ย 
ย 
sources
sources
ย 
ย 
.env.example
.env.example
ย 
ย 
.gitignore
.gitignore
ย 
ย 
CODE_OF_CONDUCT.md
CODE_OF_CONDUCT.md
ย 
ย 
CONTRIBUTING.md
CONTRIBUTING.md
ย 
ย 
Dockerfile
Dockerfile
ย 
ย 
LICENSE
LICENSE
ย 
ย 
Makefile
Makefile
ย 
ย 
README.md
README.md
ย 
ย 
README_pt-BR.md
README_pt-BR.md
ย 
ย 
action.yml
action.yml
ย 
ย 
requirements.txt
requirements.txt
ย 
ย 

Repository files navigation

Looking For Translation to different languages & Locale #23

Dev Metrics in Readme with added feature flags ๐ŸŽŒ

Project Preview

Project Preview

๐Ÿ“ŒโœจAwesome Readme Stats

Star Badge

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

  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

    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 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=<your wakatime API Key>
    • GitHub Personal Access Token as GH_TOKEN=<your github access 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:

<!--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)[#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.

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

- 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 to be passed in the flag variable example of the final result can be found here

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

Lines of code

SHOW_TOTAL_CODE_TIME flag can be set to False to hide Code Time

Code Time

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

Profile Views

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%

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

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%

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

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

Chart not found

๐Ÿ’– 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 ๐Ÿš€
  • paypal.me/aapreneur - You can make one-time donations via PayPal. I'll probably buy a 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 ๐Ÿ˜„ ๐ŸŽ‰
  • 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 are glad to add you in the list.

Made with โค๏ธ and Python ๐Ÿ.

Inspired From

Awesome Pinned Gists
athul/waka-readme

This project need a star โญ from you โ™ฅ.

Stargazers over time

Stargazers over time

About

This GitHub action helps to add cool dev metrics to your github profile Readme

Resources

Readme

License

MIT license
Activity

Stars

0 stars

Watchers

0 watching

Forks

0 forks
Report repository

Releases

No releases published

Packages

No packages published

Languages

  • Python 96.2%
  • Makefile 2.8%
  • Dockerfile 1.0%