Skip to main content

Automated WakaTime Leaderboards for your GitHub profile

Project description

Wakatime-Leaderboards📶

Automated GitHub Action and Docker container to display your WakaTime leaderboard stats in your profile README.

Badges

Workflow Status

Wakatime Leaderboards Release CodeQL & Pylint Bandit Codecov Scorecard Security Dependency Review

Code Quality & Coverage

Pylint codecov Quality Gate Status Maintainability Rating Security Rating Reliability Rating Coverage Code Smells Bugs Vulnerabilities Lines of Code Duplicated Lines (%) Technical Debt

Packaging & Deployment

Docker Image Size (tag) Docker Pulls GitHub Release Python Version from PEP 621 TOML PyPI - Version PyPI - Implementation Pepy Total Downloads PyPI - Format PyPI - Status

License & Security

GitHub License OpenSSF Scorecard OpenSSF Best Practices

Time Tracking

wakatime

Sample Output

Wakatime Leaderboards (Worldwide)

Public Leaderboards (Weekly)

Ranked Hours Coded Daily Avg
5230 19 hrs 27 mins 2 hrs 46 mins

Top Language (YAML)

Ranked Hours Coded Daily Avg
85 7 hrs 34 mins 1 hr 4 mins

Quick Start

  1. Get your WakaTime API Key
  2. Save it as GitHub Secret in your profile repository
  3. Add to your workflow:
name: Wakatime Leaderboards

on:
  schedule:
    # Runs every Monday at 12AM IST (UTC+5:30)
    - cron: "30 18 * * 0"
  workflow_dispatch:
  push:
    branches: [master]

jobs:
  update-readme:
    name: Wakatime Leaderboards
    runs-on: ubuntu-latest
    steps:
      - name: Wakatime Leaderboards
        uses: nicconike/wakatime-leaderboards@master
        with:
          WAKATIME_API_KEY: ${{ secrets.WAKATIME_API_KEY }}
  1. Add markdown comments to your README:
<!-- Wakatime-Start -->
<!-- Wakatime-End -->

Features

Feature Description
🏆 Global Leaderboards Worldwide coding stats
💻 Language Rankings Top language leaderboards
Automated Updates Scheduled via GitHub Actions
🐳 Docker Support Containerized execution

Prerequisites

  1. Wakatime API Key: API key is required to fetch your account details. Get your API key from here.
  2. Markdown Comments: Update the markdown file by adding the comments where your Wakatime Leaderboard Stats will be embedded to.

[!NOTE] Coding Activity: Total hours coded over the last 7 days from Yesterday, using default 15 minute timeout, only shows coding activity from known languages.

Public Leaderboards: You will appear in the public leaderboards only if your weekly coded hours is around 10 hrs (Changes from time to time).

Not in the Leaderboards? You can follow their Guidelines on how to show up in the Leaderboards.

Support 💙

Star ⭐ this project if you find it useful!

For detailed support options: Contributing Guide


🐛 Report Issues • 💬 Discussions

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

wakatime_leaderboards-1.2.4.tar.gz (10.7 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

wakatime_leaderboards-1.2.4-py3-none-any.whl (4.9 kB view details)

Uploaded Python 3

File details

Details for the file wakatime_leaderboards-1.2.4.tar.gz.

File metadata

  • Download URL: wakatime_leaderboards-1.2.4.tar.gz
  • Upload date:
  • Size: 10.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for wakatime_leaderboards-1.2.4.tar.gz
Algorithm Hash digest
SHA256 be6cef81b27f6d060eb2f3cb52412e927aaa217c388ba7331f9f8be0a2fa7b97
MD5 d47f8c64b5c43f92c9a803acb5f47681
BLAKE2b-256 5b437cb4b227d914e5fbee86366f2e841262e7f2ac5bf065daa4cfd69aebc304

See more details on using hashes here.

Provenance

The following attestation bundles were made for wakatime_leaderboards-1.2.4.tar.gz:

Publisher: release.yml on Nicconike/Wakatime-Leaderboards

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file wakatime_leaderboards-1.2.4-py3-none-any.whl.

File metadata

File hashes

Hashes for wakatime_leaderboards-1.2.4-py3-none-any.whl
Algorithm Hash digest
SHA256 64c64338a697bcf3ff3b2b50236372c6630a0ced181f5df0458976013ef47d2e
MD5 c97af879b38ed2852b1d69e5d797020e
BLAKE2b-256 c794386504666f40235d7ffc0af50c6e3b91b44d8e8f9817c22ba3a81e7212a5

See more details on using hashes here.

Provenance

The following attestation bundles were made for wakatime_leaderboards-1.2.4-py3-none-any.whl:

Publisher: release.yml on Nicconike/Wakatime-Leaderboards

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page