Skip to content

Wakatime widgets for displaying your code statistics in the README.md file

Notifications You must be signed in to change notification settings

syavabrazzzers/waka-widgets

Repository files navigation

WAKATIME WIDGETS (Beta)

This widgets can show your stats about your usage programming languages, editors, operating systems and more!

Usage editors

img_8.png

Usage programming languages

img_9.png


USAGE GIUDE

1. Create wakatime account and add wakatime plugin to your IDE

Example adding plugin in PyCharm

settings --> plugins --> search 'wakatime'

After install plugin you need add wakatime api key from wakatime site to plugin

If you did everything right, you will see this icon in the lower right corner in JetBrains IDEs

img.png

2. Create GitHub secret Token

Go to settings --> Developer settings -->

img_2.png img_4.png

Enter token name

Select expiration as 'No expiration'

Select 'repo' scope

Click 'Generate token'

3. Create action for your repository

Create action

img.png

Edit action

img_1.png

  1. Enter action file name (can be any)
  2. Write configuration for run action
name: Waka Readme

on:
 schedule:
   - cron: '0 1 * * *' # Run at 1:00 AM (you can edit it)
 workflow_dispatch:
jobs:
 update-readme:
   name: Update Readme with Metrics
   runs-on: ubuntu-latest
   steps:
     - uses: syavabrazzzers/waka-widgets@main
       with:
         WAKATIME_API_KEY: ${{secrets.WAKATIME_API_KEY}}
         GH_TOKEN: ${{secrets.GH_TOKEN}}
  1. Commit changes

Add secrets GitHub token and Wakatime API Key to action

Add GH_TOKEN and WAKATIME_API_KEY secrets (secret names need be like this)

img_5.png

img_6.png

4. Edit README.md file

Include this strings to your README.md file

<!--START_SECTION:waka-->
<!--END_SECTION:waka-->

Widgets will be created in this block

Conclusion

And now, if you did everything right, your README will be updated daily at 1 am (if you did not change in the action file)

But

You can force widget generation as follows

img_7.png img_10.png

About

Wakatime widgets for displaying your code statistics in the README.md file

Resources

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published