alexlostorto / github-streak

Automatically update and track your GitHub streak.

Github Streak

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

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

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

⚡ Quick setup

1. Clone the repo

git clone https://github.com/alexlostorto/github-streak

2. Rename .env.example to .env

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

TOKEN=ghp_example
USER=username

4. Install dependencies

pip install -r requirements.txt

5. Run main.py

python main.py

6. Star the repo 😄

📜 Credits

Everything is coded by Alex lo Storto

Licensed under the MIT License.