GitHub Action
Profile Readme Development Stats
Looking For Translation to different languages #23
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!
- 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 metricsenable
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>
- WakaTime-api-key as
- You can enable and disable feature flags based on requirements.
This Action will run everyday at 00.00 IST
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.
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.
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 }}
- 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"
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%
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_LOC_CHART
flag can be set to False
to hide the Lines of code written in different quarters of different year
Timeline
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
beerwine ๐ท
Thanks! โค๏ธ
Contributions are welcome! โฅ! Please share any features, and add unit tests! Use the pull request and issue systems to contribute.
- Anmol Pratap Singh: maintainer
- Prabhat Singh: For code timeline graph
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 Special Mention ๐ we are glad to add you in the list.
Made with โค๏ธ and Python ๐.