Looking For Translation to different languages & Locale #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
repoanduserscope from here if you're running the action to get commit metricsenabling the
reposcope 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
- 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>
- 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-->
```txt
C++ 1 hr 27 mins ███████████▓░░░░░░░░░░░░░ 46.43 %
Python 41 mins █████▓░░░░░░░░░░░░░░░░░░░ 22.10 %
CMake 40 mins █████▒░░░░░░░░░░░░░░░░░░░ 21.48 %
JavaScript 15 mins ██░░░░░░░░░░░░░░░░░░░░░░░ 08.08 %
ObjectiveC 1 min ▒░░░░░░░░░░░░░░░░░░░░░░░░ 01.01 %
`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 <https://wakatime.com> 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 = <Your GitHub Access Token>`
Here is Sample Workflow File for running it:
```yml
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
Actionsin your repo and select yourProfile Readme Development Statsworkflow and click inRun 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
FLAGSin 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"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
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 🐤
🌞 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
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
- Alexander Sergeev: 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
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 🐍.
