A fun and motivating tool that tracks your GitHub activity and provides encouraging messages based on your commit activity. For developers who want some extra positivity!

• Activity Tracking: Monitors your GitHub commits for today and the past week
• Private & Public Repos: With a GitHub token, tracks activity across all your repositories
• Git Hooks Integration: Automatically runs after every commit with git hooks
• Randomized Messages: Multiple message variations keep the experience fresh
• Easy Setup: Simple configuration with just your GitHub username and token

1. Clone the repository:

   git clone https://github.com/Emmyme/github-cheer
   cd github-cheer

2. Install dependencies:

   pip install -r requirements.txt

3. Configure your GitHub credentials:

   For local installation - Edit cheer/cli.py:

   USERNAME = "your-github-username"  # Change this to your GitHub username
   TOKEN = None  # Optional: Set to your token for authenticated requests

   Or set environment variables (recommended for global use): The script automatically checks for GITHUB_USERNAME and GITHUB_TOKEN environment variables first.

   For global installation - Set environment variables:

   Unix/Linux/macOS:

   # Add these lines to your shell profile (.bashrc, .zshrc, etc.)
   export GITHUB_USERNAME="your-github-username"
   export GITHUB_TOKEN="your-github-token"  # Optional
   
   # Then reload your profile:
   source ~/.bashrc  # or ~/.zshrc

   Windows PowerShell:

   # Add these lines to your PowerShell profile
   $env:GITHUB_USERNAME = "your-github-username"
   $env:GITHUB_TOKEN = "your-github-token"  # Optional
   
   # Or set them for current session:
   $env:GITHUB_USERNAME = "your-github-username"
   $env:GITHUB_TOKEN = "your-github-token"

   Note: A GitHub Personal Access Token is recommended to access private repositories and get higher rate limits. Without a token, only public repository activity is tracked.

4. Install git hooks (optional):

   Local installation (for this repository only):

   chmod +x install-hooks.sh
   ./install-hooks.sh

   Global installation (for all repositories):

   # 1. Set up a global git hooks directory
   git config --global core.hooksPath ~/.git-hooks
   
   # 2. Create the global hooks directory
   mkdir ~/.git-hooks
   
   # 3. Copy the hook and cheer module to the global location
   cp hooks/post-commit ~/.git-hooks/
   cp -r cheer ~/.git-hooks/
   cp requirements.txt ~/.git-hooks/
   
   # 4. Install dependencies globally
   pip install -r ~/.git-hooks/requirements.txt

   What this does:

   • Sets up a global hooks directory that works for all repositories
   • Copies the GitHub Cheer tool to the global location
   • Installs required dependencies globally
   • The hook will now run after every commit in any repository

Run the script directly to see your activity:

python cheer/cli.py

Once you've installed the git hooks, the script will automatically run after every git commit, showing you an encouraging message about your activity.

Note:

• Local hooks only work in this repository
• Global hooks work in all repositories after setup
• The tool tracks commits pushed to GitHub, not local commits that haven't been pushed yet

The tool uses the GitHub API to fetch your recent activity and analyzes your commit activity:

• Today's commits: Counts all commits pushed to GitHub today
• Weekly commits: Counts all commits pushed to GitHub in the past 7 days

Important: Only commits that have been pushed to GitHub are counted. Local commits that haven't been pushed yet won't appear in your activity count.

Based on your activity, you'll receive different encouraging messages with randomized variations:

• Super achiever: 8+ commits today → "Incredible! X commits today! You're absolutely crushing it!"
• High achiever: 5+ commits today → "Amazing! X commits today! You're in the zone!"
• Good progress: 3+ commits today → "Excellent! X commits today! Keep crushing it!"
• Strong week: 25+ commits this week → "Outstanding! X commits this week! You're unstoppable!"
• Consistent coder: 10+ commits this week → "Great week! X commits! You're on fire!"
• Getting started: Various encouraging messages for lower activity levels

Each message tier has multiple variations that rotate randomly to keep the experience fresh!

github-cheer/
├── cheer/
│   ├── __init__.py
│   ├── api.py          # GitHub API integration
│   ├── cli.py          # Command-line interface
│   └── messages.py     # Encouraging message logic
├── hooks/
│   └── post-commit     # Git hook script
├── install-hooks.sh    # Hook installation script
├── requirements.txt    # Python dependencies
└── README.md          # This file

• requests: For GitHub API calls
• colorama: For colored terminal output

Feel free to contribute to this project! Some ideas:

• Add more message variations
• Support for different time periods
• Integration with other Git hosting platforms
• Web dashboard for activity visualization

This project is licensed under the MIT License - see the LICENSE file for details.

If you encounter any issues or have questions, please open an issue on GitHub.

Keep on coding!