xyvs/wakapi-readme-stats
1
0
Fork 0
Code Issues 2 Pull Requests 1 Actions Packages Projects Releases 1 Wiki Activity

FIX: Updated README.md

Browse Source
This commit is contained in:
Anmol
2020-07-21 14:02:17 +05:30
parent 265addd251
commit 36336b6557
1 changed files with 53 additions and 63 deletions
Download Patch File Download Diff File Expand all files Collapse all files

116
README.md
View File

@@ -1,23 +1,46 @@
# Dev Metrics in Readme # Dev Metrics in Readme with added feature flags 🎌
![Project Preview](https://user-images.githubusercontent.com/15426564/88030180-8e1c4780-cb58-11ea-8a8b-b3576dd73652.png)
<p align="center">
![Project Preview](https://user-images.githubusercontent.com/25841814/79395484-5081ae80-7fac-11ea-9e27-ac91472e31dd.png)
<h3 align="center">📌✨Awesome Readme Stats</h3>
</p>
![Project Preview](https://user-images.githubusercontent.com/15426564/87876319-0b2eac00-c9f5-11ea-9049-233c1b260e7f.png)
---- ----
[WakaTime](https://wakatime.com) Weekly Metrics on your Profile Readme: <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 ## Prep Work
1. You need to update the markdown file(.md) with 2 comments. You can refer [here](#update-your-readme) for updating it. 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 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 - You can refer [here](#new-to-wakatime), if you're new to WakaTime
3. **Optional** You'll need a GitHub API Token with `repo` scope from [here](https://github.com/settings/tokens) if you're running the action not in your Profile Repository 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
- You can use [this](#other-repository-not-profile) example to work it out > enable `repo` scope seems **DANGEROUS**<br/>
4. You need to save the WakaTime API Key (and the GitHub API Token, if you need it) in the repository secrets. You can find that in the Settings of your Repository.Be sure to save those as the following. > 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 - WakaTime-api-key as `WAKATIME_API_KEY = <your wakatime API Key>`and
- The GitHub Access Token as `GH_TOKEN=<your github access token>` - The GitHub Access Token as `GH_TOKEN=<your github access token>`
5. You can follow either of the Two Examples according to your needs to get started with. 5. You can enable and disable feature flags based on requirements.
> I strongly suggest you to run the Action in your Profile Repo since you won't be needing a GitHub Access Token
This Action will run everyday at 00.00 IST This Action will run everyday at 00.00 IST
@@ -43,32 +66,6 @@ WakaTime gives you an idea of the time you really spent on coding. This helps yo
### Profile Repository ### Profile Repository
*If you're executing the workflow on your Profile Repository (`<username>/<username>`)*
> You wouldn't need an GitHub Access Token since GitHub Actions already makes one for you.
Here is a sample workflow file for you to get started:
```yml
name: Waka Readme
on:
schedule:
# Runs at 12am IST
- cron: '30 18 * * *'
jobs:
update-readme:
name: Update this repo's README
runs-on: ubuntu-latest
steps:
- uses: anmol098/waka-readme@master
with:
WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
```
### Other Repository (not Profile)
*If you're executing the workflow on another repo other than `<username>/<username>`* *If you're executing the workflow on another repo other than `<username>/<username>`*
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>` 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>`
@@ -88,7 +85,7 @@ jobs:
name: Update Readme with Metrics name: Update Readme with Metrics
runs-on: ubuntu-latest runs-on: ubuntu-latest
steps: steps:
- uses: anmol098/waka-readme@master - uses: anmol098/waka-readme-stats@master
with: with:
WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }} WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
GH_TOKEN: ${{ secrets.GH_TOKEN }} GH_TOKEN: ${{ secrets.GH_TOKEN }}
@@ -99,7 +96,7 @@ jobs:
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 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 ```yml
- uses: anmol098/waka-readme@master - uses: anmol098/waka-readme-stats@master
with: with:
WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }} WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
GH_TOKEN: ${{ secrets.GH_TOKEN }} GH_TOKEN: ${{ secrets.GH_TOKEN }}
@@ -109,7 +106,18 @@ jobs:
``` ```
#### Flags Available #### Flags Available
`SHOW_OS` flag can be set to `False` to hide the OS details `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 ```text
💬 Languages: 💬 Languages:
@@ -118,7 +126,12 @@ PHP 1 hr 35 mins ████░░░░░░░
Markdown 1 hr 9 mins ███░░░░░░░░░░░░░░░░░░░░░░ 13.3% Markdown 1 hr 9 mins ███░░░░░░░░░░░░░░░░░░░░░░ 13.3%
Python 22 mins █░░░░░░░░░░░░░░░░░░░░░░░░ 4.32% Python 22 mins █░░░░░░░░░░░░░░░░░░░░░░░░ 4.32%
XML 8 mins ░░░░░░░░░░░░░░░░░░░░░░░░░ 1.62% XML 8 mins ░░░░░░░░░░░░░░░░░░░░░░░░░ 1.62%
```
`SHOW_OS` flag can be set to `False` to hide the OS details
```text
💻 Operating Systems: 💻 Operating Systems:
Windows 8 hrs 46 mins █████████████████████████ 100.0% Windows 8 hrs 46 mins █████████████████████████ 100.0%
``` ```
@@ -126,53 +139,30 @@ Windows 8 hrs 46 mins ███████████
`SHOW_PROJECTS` flag can be set to `False` to hide the Projects worked on `SHOW_PROJECTS` flag can be set to `False` to hide the Projects worked on
```text ```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%
🐱‍💻 Projects: 🐱‍💻 Projects:
ctx_connector 4 hrs 3 mins ███████████░░░░░░░░░░░░░░ 46.33% ctx_connector 4 hrs 3 mins ███████████░░░░░░░░░░░░░░ 46.33%
NetSuite-Connector 1 hr 31 mins ████░░░░░░░░░░░░░░░░░░░░░ 17.29% NetSuite-Connector 1 hr 31 mins ████░░░░░░░░░░░░░░░░░░░░░ 17.29%
mango-web-master 1 hr 12 mins ███░░░░░░░░░░░░░░░░░░░░░░ 13.77% mango-web-master 1 hr 12 mins ███░░░░░░░░░░░░░░░░░░░░░░ 13.77%
cable 54 mins ██░░░░░░░░░░░░░░░░░░░░░░░ 10.41% cable 54 mins ██░░░░░░░░░░░░░░░░░░░░░░░ 10.41%
denAPI 40 mins ██░░░░░░░░░░░░░░░░░░░░░░░ 7.66% denAPI 40 mins ██░░░░░░░░░░░░░░░░░░░░░░░ 7.66%
``` ```
`SHOW_TIMEZONE` flag can be set to `False` to hide the time zone you are in `SHOW_TIMEZONE` flag can be set to `False` to hide the time zone you are in
```text ```text
⌚︎ Timezone: Asia/Calcutta ⌚︎ Timezone: Asia/Calcutta
💬 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_EDITORS` flag can be set to `False` to hide the code-editor list you use `SHOW_EDITORS` flag can be set to `False` to hide the list of code-editors used
```text ```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%
🔥 Editors: 🔥 Editors:
WebStorm 6 hrs 47 mins ███████████████████░░░░░░ 77.43% WebStorm 6 hrs 47 mins ███████████████████░░░░░░ 77.43%
PhpStorm 1 hr 35 mins ████░░░░░░░░░░░░░░░░░░░░░ 18.07% PhpStorm 1 hr 35 mins ████░░░░░░░░░░░░░░░░░░░░░ 18.07%
PyCharm 23 mins █░░░░░░░░░░░░░░░░░░░░░░░░ 4.49% PyCharm 23 mins █░░░░░░░░░░░░░░░░░░░░░░░░ 4.49%
``` ```
This project is inspired from [athul/waka-readme](https://github.com/athul/waka-readme) with added extra feature. > 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. ### Don't forget to leave a ⭐ if you found this useful.