Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/avinal/profile-readme-wakatime
Generate coding activity graph tracked by WakaTime to embed in Readme(s) and webpages.
https://github.com/avinal/profile-readme-wakatime
coding-activity coding-graph data-scraped docker github github-actions github-actions-docker graph image-processing matplotlib portfolio-graph profile-readme profile-readme-wakatime python readme time-tracking utc wakatime wakatime-api web-widgets
Last synced: 13 days ago
JSON representation
Generate coding activity graph tracked by WakaTime to embed in Readme(s) and webpages.
- Host: GitHub
- URL: https://github.com/avinal/profile-readme-wakatime
- Owner: avinal
- License: mit
- Created: 2020-11-07T19:19:37.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2024-04-23T16:24:14.000Z (7 months ago)
- Last Synced: 2024-04-23T17:54:42.443Z (7 months ago)
- Topics: coding-activity, coding-graph, data-scraped, docker, github, github-actions, github-actions-docker, graph, image-processing, matplotlib, portfolio-graph, profile-readme, profile-readme-wakatime, python, readme, time-tracking, utc, wakatime, wakatime-api, web-widgets
- Language: Python
- Homepage: https://avinal.space/posts/development/wakatime-readme
- Size: 268 KB
- Stars: 85
- Watchers: 3
- Forks: 45
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
**NOTE: This project is complete and requires no additional development at this stage. If you find an issue or have ideas for new features, please open an issue. In the meantime I am trying to migrate it from Python, until that happens this is all the project has to offer.**
---
If you use WakaTime to track your coding activity. You can add that to your README as a bar graph or embed in your blog/portfolio. Just add this action to any of your repository and there you have it. See mine below.
## My WakaTime Coding Activity
## How to add one to your README.md
1. First get your WakaTime API Key. You can get it from your [WakaTime](https://wakatime.com) account settings.
2. Save WakaTime API Key to Repository Secret. Find that by clicking the Settings tab. Keep the name of secret as **WAKATIME_API_KEY**.
3. Add following line in your README.md of your repo.
```html
Example:
```
You can use this method to embed in web pages too. _Do not use markdown method of inserting images. It does not work some times._
4. Click **Action** tab and **choose set up a workflow yourself**.
5. Copy the following code into the opened file, you can search for **WakaTime Stat** in marketplace tab for assistance.
```yml
name: WakaTime status update
on:
schedule:
# Runs at 12 am '0 0 * * *' UTC
- cron: "1 0 * * *"
jobs:
update-readme:
name: Update the WakaTime Stat
runs-on: ubuntu-latest
steps:
# Use avinal/Profile-Readme-WakaTime@ for latest stable release
# Do not change the line below until you have forked this repository
# If you have forked this project you can use /Profile-Readme-WakaTime@master instead
- uses: avinal/Profile-Readme-WakaTime@master
with:
# WakaTime API key stored in secrets, do not directly paste it here
WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
# Automatic github token
GITHUB_TOKEN: ${{ github.token }}
# Branch - newer GitHub repositories have "main" as default branch, change to main in that case, default is master
BRANCH: "master"
# Manual Commit messages - write your own messages here
COMMIT_MSG: "Automated Coding Activity Update :alien:"
# Range of fetching data - default is "last_7_days". See https://wakatime.com/developers#stats for more options
STATS_RANGE: "last_7_days"
```
6. Please wait till 12 AM UTC to run this workflow automatically. Or you can force run it by going to Action tab. Or you can add following lines under `on:` to run with every push. Search for 12 AM UTC to find equivalent time in your time zone.
```yml
on:
push:
branches: [master]
schedule:
- cron: "1 0 * * *"
```