You've already forked wakapi-readme-stats
167 lines
7.0 KiB
Markdown
167 lines
7.0 KiB
Markdown
# Dev Metrics in Readme with added feature flags 🎌
|
|
|
|
|
|
|
|
<p align="center">
|
|
|
|
|
|
|
|
<h3 align="center">📌✨Awesome Readme Stats</h3>
|
|
</p>
|
|
|
|
----
|
|
|
|
<p align="center">
|
|
<img src="https://img.shields.io/badge/language-python-blue?style"/>
|
|
<img src="https://img.shields.io/github/license/anmol098/waka-readme-stats"/>
|
|
<img src="https://img.shields.io/github/stars/anmol098/waka-readme-stats"/>
|
|
<img src="https://img.shields.io/github/forks/anmol098/waka-readme-stats"/>
|
|
</p>
|
|
<p align="center">
|
|
Are you an early 🐤 or a night 🦉?
|
|
<br/>
|
|
When are you most productive during the day?
|
|
<br/>
|
|
The languages you code in
|
|
<br/>
|
|
Let's check out in your readme!
|
|
</p>
|
|
|
|
## 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**<br/>
|
|
> 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 = <your wakatime API Key>`and
|
|
- The GitHub 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:
|
|
|
|
```md
|
|
<!--START_SECTION:waka-->
|
|
<!--END_SECTION:waka-->
|
|
```
|
|
|
|
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` 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 * * *'
|
|
|
|
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: <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: <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) <br/>
|
|
>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.
|