# 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?
The languages you code in
Let's check out in your 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` scope from [here](https://github.com/settings/tokens) if you're running the action to get commit metrics
> enable `repo` scope seems **DANGEROUS**
> but this GitHub Action only accesses your commit timestamp 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 = `and
- The GitHub 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
```
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` scope and save it in the Repo Secrets `GH_TOKEN = `
Here is Sample Workflow File for running it:
```yml
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 }}
USERNAME: # optional, it will automatically use the username of the owner of the repository who's executing the workflow.
```
## 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
```yml
- uses: anmol098/waka-readme-stats@master
with:
WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
GH_TOKEN: ${{ secrets.GH_TOKEN }}
USERNAME:
SHOW_OS: "False"
SHOW_PROJECTS: "False"
```
#### Flags Available
`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_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%
```
> This project is inspired by an awesome pinned-gist project [Awesome Pinned Gists](https://github.com/matchai/awesome-pinned-gists)
>This project is inspired from [athul/waka-readme](https://github.com/athul/waka-readme)
### Don't forget to leave a β if you found this useful.