Skip to content

About

Generator Github contribution info, made because you need pro for private repo, also it appends to readme

Resources

Stars

0 stars

Watchers

0 watching

Forks

Latest commit

 

History

11 Commits

Folders and files

Repository files navigation

GitHub Contribution Generator

A Python tool that automatically generates detailed contributor statistics and documentation for GitHub repositories. Created to provide contribution tracking without needing GitHub Pro for private repositories and also it appends them to your readme

Contributors

This section is automatically generated based on git commit history. Click 'files' to view detailed file contributions.

Total Contributors: 5 | Total Commits: 9

👥 5 Contributors 📝 9 Commits
📊 993 LOC 📁 16 Files
🌿 2 Branches 🏷️ 0 Tags
💾 53.7KB Size 📅 0 Days Old
🔤 Top Extensions: md (12), gitignore (1), no-ext (1)

🏆 @davidkumar ██████████ 2 commits (22.2%) files 🟢8 🔴1 📊+7 📁2 (2025-09)

🥇 @carolmartinez ██████████ 2 commits (22.2%) files 🟢7 🔴0 📊+7 📁2 (2025-09)

🥈 @bobchen ██████████ 2 commits (22.2%) files 🟢3 🔴0 📊+3 📁2 (2025-09)

✨ @alicejohnson ██████████ 2 commits (22.2%) files 🟢2 🔴0 📊+2 📁1 (2025-09)

✨ @soda4fries █████░░░░░ 1 commits (11.1%) files 🟢0 🔴0 📊+0 📁0

Last updated: 2025-09-09 00:44:44

Features

  • Automatic README Integration - Updates README with contributor section
  • Detailed Statistics - Tracks commits, lines, files, timeline data
  • Alias Management - Handles multiple identities per contributor
  • Individual Reports - Generates detailed file contribution docs
  • Rich Formatting - Progress bars, emojis, compact display

Installation

  1. Download script: wget https://raw.githubusercontent.com/soda4fries/Github-Contribution-Generator/main/contribution.py or curl -O https://raw.githubusercontent.com/soda4fries/Github-Contribution-Generator/main/contribution.py
  2. Requires Python 3.6+ (no additional dependencies)

Usage

python contribution.py                    # Update README with contributors
python contribution.py contributors.md   # Generate standalone file
python contribution.py --list-aliases    # Show alias mappings
python contribution.py --files          # Generate individual docs only

Add these markers to your README where you want the contributor section to appear:

<!-- CONTRIBUTORS-START -->
<!-- CONTRIBUTORS-END -->

Configuration

Aliases: Edit aliases dictionary in contribution.py to merge identities:

self.aliases = {
    "John Doe <john@example.com>": ["John Doe <john@work.com>", "johndoe <john@example.com>"]
}

GitHub Links: Add profile mappings:

self.github_profiles = {"John Doe <john@example.com>": "@johndoe"}

Workflow: --list-aliases → edit script → regenerate

Features Tracked

  • Commits, lines added/removed, files changed
  • Repository stats (size, age, branches, tags, file types)
  • Timeline data and contributor profiles

Troubleshooting

  • "Error running git command" → Run from git repository root
  • Duplicated contributors → Add aliases in script
  • Missing GitHub links → Update github_profiles dictionary
  • README not updating → Ensure contributor markers exist

Automation Examples

GitHub Actions:

on: [push]
jobs:
  update-contributors:
    runs-on: ubuntu-latest
    steps:
    - uses: actions/checkout@v2
    - run: python contribution.py && git add . && git commit -m "Update contributors" && git push

Shell Aliases:

alias update-contributors='python contribution.py'
alias check-aliases='python contribution.py --list-aliases'

About

Generator Github contribution info, made because you need pro for private repo, also it appends to readme

Resources

Stars

0 stars

Watchers

0 watching

Forks

Releases

Packages

Contributors

Languages