Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/siddhant-k-code/github-contribution-tracker
CLI tool to fetch and beautifully format all your GitHub contributions to any organization!
https://github.com/siddhant-k-code/github-contribution-tracker
github-api github-contributions python tracker
Last synced: 2 days ago
JSON representation
CLI tool to fetch and beautifully format all your GitHub contributions to any organization!
- Host: GitHub
- URL: https://github.com/siddhant-k-code/github-contribution-tracker
- Owner: Siddhant-K-code
- Created: 2025-01-24T17:50:50.000Z (17 days ago)
- Default Branch: main
- Last Pushed: 2025-01-24T17:57:55.000Z (17 days ago)
- Last Synced: 2025-02-04T21:56:18.627Z (6 days ago)
- Topics: github-api, github-contributions, python, tracker
- Language: Python
- Homepage:
- Size: 8.79 KB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# 🚀 GitHub Contribution Tracker
A powerful CLI tool to fetch and beautifully format all your GitHub contributions to any organization!
## ✨ Features
- 📊 Comprehensive contribution tracking
- Pull Requests (open, closed, merged)
- Issues
- Commits
- 📝 Beautiful Markdown export
- 📅 Chronological sorting
- 🔍 Detailed statistics
- 🎯 Organization-specific insights
## 🛠️ Installation
1. Clone this repository:
```bash
git clone https://github.com/Siddhant-K-code/github-contribution-tracker
cd github-contribution-tracker
```
2. Install dependencies:
```bash
pip install requests
```
3. Set up your GitHub token:
```bash
export GITHUB_TOKEN=your_github_personal_access_token
```
## 🎮 Usage
Run the tracker with:
```bash
python main.py USERNAME ORGANIZATION_NAME
```
Example:
```bash
python main.py Siddhant-K-code OpenFGA
```
## 📦 Output
The tool generates a beautifully formatted contributions.md file containing:
### 📊 Summary Section
- Total Pull Requests
- Total Issues
- Total Commits
### 📝 Detailed Sections
- Pull Requests: Title, status, and date
- Issues: Title, status, and date
- Commits: Message and date
## 🔑 GitHub Token Permissions
Your token needs these scopes:
- `repo`
- `read:org`
- `read:user`
## 💡 Example Output
```markdown
# GitHub Contributions for Siddhant-K-code in OpenFGA
## Summary
- Total Pull Requests: 42
- Total Issues: 15
- Total Commits: 123
## Detailed Contributions
[...]
```
## 🛠️ Technical Details
- Uses GitHub's GraphQL API
- Implements pagination for complete data retrieval
- Sorts contributions chronologically
- Handles rate limiting gracefully