A beautiful, full-featured Python application for displaying GitHub repository statistics on a Raspberry Pi or any computer with a display. Perfect for monitoring your open-source projects, tracking package downloads, and displaying donation totals.

• 📊 Comprehensive Statistics: Track stars, forks, issues, commits, and more
• 📦 Package Downloads: Monitor GitHub Container Registry package downloads
• 💝 Donation Tracking: Display totals from PayPal and Buy Me a Coffee
• 🖥️ Multiple Display Modes:
  • Full-screen GUI for HDMI displays
  • Character LCD support (I2C/GPIO)
  • Terminal output for development
• 🎨 Beautiful Modern UI: Dark theme with color-coded stat cards
• ⚡ Smart Caching: Reduces API calls and respects rate limits
• 🔄 Auto-refresh: Automatically updates at configurable intervals
• 📱 Raspberry Pi Ready: Optimized for low-power devices

• Python 3.7 or higher
• GitHub Personal Access Token (with appropriate permissions)
• Display device (HDMI monitor, character LCD, or terminal)

• For Character LCD: RPLCD and RPi.GPIO (for Raspberry Pi)
• For GUI Display: tkinter (usually included with Python)

1. Clone or download this repository

git clone <repository-url>
cd GithubRepoStats

1. Install Python dependencies

pip install -r requirements.txt

1. For Raspberry Pi with Character LCD (optional):

pip install -r requirements-raspberrypi.txt

Note: The Raspberry Pi dependencies (RPLCD and RPi.GPIO) are only needed if you're using a character LCD display on a Raspberry Pi. They cannot be installed on Windows/Mac and are not required for GUI or terminal displays.

1. Copy the example configuration file

cp config.yaml.example config.yaml

1. Edit config.yaml with your settings

# GitHub Personal Access Token
# Create one at: https://github.com/settings/tokens
# Required permissions: public_repo (or repo for private repos), read:packages
github_token: "your_github_token_here"

# List of repositories to track
repositories:
  - "owner/repo-name-1"
  - "owner/repo-name-2"

# Refresh interval in minutes
refresh_interval_minutes: 15

# Display type: terminal, character_lcd, gui, or fullscreen
display_type: fullscreen

1. Go to GitHub Settings > Developer settings > Personal access tokens
2. Click "Generate new token (classic)"
3. Select the following scopes:
   • public_repo (for public repositories) or repo (for private repos)
   • read:packages (for package download statistics)
4. Copy the token and paste it into config.yaml

display_type: fullscreen  # or "gui"

display_settings:
  fullscreen: true
  bg_color: "#0a0e27"      # Dark blue background
  text_color: "#ffffff"    # White text
  accent_color: "#00d4ff"  # Cyan accent
  font_family: "Segoe UI"  # Font name
  title_font_size: 64
  body_font_size: 32
  small_font_size: 20

display_type: character_lcd

display_settings:
  mode: i2c
  i2c_address: 0x27  # Default I2C address
  i2c_port: 1        # I2C port (usually 1 on Raspberry Pi)
  width: 20
  height: 4

display_type: character_lcd

display_settings:
  mode: gpio
  pin_rs: 15
  pin_e: 16
  pins_data: [21, 22, 23, 24]
  numbering_mode: BCM  # Options: BCM or BOARD
  width: 20
  height: 4

github_packages:
  # Simple format
  - "owner/package-name"
  
  # Full format with type specification
  - owner: "owner"
    name: "package-name"
    type: "container"  # Options: container, npm, maven, nuget, rubygems

Note: GitHub Container Registry doesn't expose download counts via API. The app will automatically use release asset downloads as a fallback.

donations:
  enabled: true
  buymeacoffee:
    username: "your-username"  # Your Buy Me a Coffee username

The app will scrape your public Buy Me a Coffee page to extract total donations.

donations:
  enabled: true
  paypal:
    client_id: "your_client_id"
    client_secret: "your_client_secret"

Get PayPal API credentials from PayPal Developer Dashboard.

# Options: summary or per_repo
view_mode: summary  # Shows aggregated stats across all repos
# view_mode: per_repo  # Shows individual repository details

cache_enabled: true
cache_duration_minutes: 10  # How long to cache API responses
cache_dir: .cache           # Cache directory

python main.py

python main.py --config /path/to/config.yaml

1. For HDMI Display (Full-screen GUI):

python main.py

The app will start in full-screen mode. Press Escape to exit.

1. For Character LCD:

Make sure your LCD is properly connected:

• I2C: Connect SDA, SCL, VCC, and GND
• GPIO: Connect according to your pin configuration

Then run:

python main.py

1. Auto-start on Boot (Optional):

Create a systemd service or add to /etc/rc.local:

cd /path/to/GithubRepoStats
python3 main.py &

The summary view shows aggregated statistics:

• Total stars across all repositories
• Total forks
• Total open issues
• Number of active repositories
• Package downloads (if configured)
• Total donations (if configured)
• Most starred repository

The per-repository view shows detailed stats for each repo:

• Repository name and description
• Stars and forks
• Open issues
• Primary programming language
• Latest version (if available)
• Release downloads
• Last commit time

If you see rate limit errors:

• Ensure your GitHub token is configured correctly
• The app automatically caches responses to reduce API calls
• Increase cache_duration_minutes in config
• Reduce refresh_interval_minutes

GitHub Container Registry doesn't expose download counts via API. The app will:

1. Try to get counts from package versions (often returns 0)
2. Automatically fall back to release asset downloads
3. Display release downloads if package downloads are unavailable

The app scrapes your public Buy Me a Coffee page. If it's not working:

• Verify your username is correct
• Check that your profile is public
• The page structure may have changed (check error logs)
• Consider using manual configuration as a fallback

1. Check I2C connection:

sudo i2cdetect -y 1  # Should show your LCD address (usually 0x27)

1. Check GPIO pins match your configuration

2. Verify permissions:

sudo usermod -a -G i2c,gpio $USER
# Log out and back in

1. Test with a simple script:

from RPLCD import I2CCharLCD
lcd = I2CCharLCD('PCF8574', 0x27)
lcd.write_string('Hello World')

• Ensure tkinter is installed:

  # Ubuntu/Debian
  sudo apt-get install python3-tk
  
  # macOS (usually pre-installed)
  # Windows (usually pre-installed)

If you see import errors:

pip install -r requirements.txt

For Raspberry Pi LCD support:

pip install RPLCD RPi.GPIO

GithubRepoStats/
├── main.py                      # Main application entry point
├── github_fetcher.py            # GitHub API client
├── github_packages_fetcher.py   # GitHub Packages API client
├── donations_fetcher.py         # Donation tracking (PayPal, Buy Me a Coffee)
├── cache_manager.py             # Caching system
├── metrics_calculator.py        # Metrics calculation and aggregation
├── utils.py                     # Utility functions
├── display/
│   ├── base.py                  # Abstract display interface
│   ├── gui.py                   # Full-screen GUI display
│   ├── terminal.py              # Terminal/console display
│   └── character_lcd.py        # Character LCD display
├── config.yaml                  # Your configuration (create from example)
├── config.yaml.example          # Example configuration
├── requirements.txt             # Python dependencies
└── README.md                    # This file

See config.yaml.example for a complete configuration reference with all available options and detailed comments.

Contributions are welcome! Please feel free to submit a Pull Request.

This project is licensed under the MIT License.

For issues, questions, or feature requests, please open an issue on GitHub.

• Built with Python and tkinter
• Uses GitHub REST API
• Supports various display types for maximum flexibility

Enjoy monitoring your GitHub statistics! 🚀