Skip to content

alexlostorto/github-streak

Repository files navigation

Github Streak

Display your total contributions, current streak, and longest streak in your terminal.

Maintainability

The program automatically retrieves the user's streak statistics using GitHub's GraphQL API.

# Examples in console
+---------------------+----------+      ╭─────────────────────┬──────────╮
|       Category      |  Count   |CategoryCount+---------------------+----------+      ├─────────────────────┼──────────┤
|    Current Streak   | 102 days |Current Streak104 days|    Longest Streak   | 102 days |Longest Streak104 days| Total Contributions |   642    |Total Contributions658+---------------------+----------+      ╰─────────────────────┴──────────╯

⚡ Quick setup

  1. Clone the repo
git clone https://github.com/alexlostorto/github-streak
  1. Rename .env.example to .env

  2. Replace the username with any GitHub username and replace ghp_example with your personal access token.

TOKEN=ghp_example
USER=username
  1. Install dependencies
pip install -r requirements.txt
  1. Run main.py
python main.py
  1. Star the repo 😄

📜 Credits

Everything is coded by Alex lo Storto

Licensed under the MIT License.