git-digest

Summarize recent Git contributions into clear, human-readable updates using AI. Perfect for standup meetings, progress reports, and understanding what happened in your repositories.

Features

• 🤖 AI-Powered Summaries: Uses Cohere, OpenAI or Anthropic to generate intelligent summaries
• 📁 Multi-Repository Support: Analyze multiple repositories simultaneously
• 👥 Author Filtering: Focus on specific contributors' work
• 📅 Flexible Date Ranges: Filter by date, days, or commit count
• 🎯 Two Summary Modes: Chronological overview or grouped by author
• 🔍 Cross-Repository Analysis: Identify related work across multiple projects
• 📊 Detailed Logging: Track what's being analyzed with debug mode

Installation

Using pip

pip install git-digest

Using pipx (recommended)

pipx install git-digest

From source

git clone https://github.com/rafidka/git-digest.git
cd git-digest
uv sync

Setup

You'll need an API key for one of the supported LLM providers:

OpenAI

export OPENAI_API_KEY="your-api-key-here"

Cohere (default)

export COHERE_API_KEY="your-api-key-here"

Anthropic

export ANTHROPIC_API_KEY="your-api-key-here"

Quick Start

# Summarize the current repository (last 7 days)
git-digest .

# Summarize multiple repositories
git-digest /path/to/repo1 /path/to/repo2

# Use a specific LLM provider
git-digest . --provider openai

# Get commits from a specific time period
git-digest . --since "2024-01-01" --until "2024-01-31"

# Focus on specific authors
git-digest . --authors "alice,bob"

# Group summary by author instead of chronological
git-digest . --by-author

Usage Examples

Basic Usage

# Analyze current directory (default: last 7 days)
git-digest .

# Analyze specific repository
git-digest /path/to/my/project

# Multiple repositories
git-digest ~/projects/frontend ~/projects/backend ~/projects/mobile

Time Filtering

# Last N days
git-digest . --days 14

# Last N commits
git-digest . --count 50

# Specific date range
git-digest . --since "2024-01-01" --until "2024-01-31"

# Natural language dates
git-digest . --since "last monday" --until "yesterday"
git-digest . --since "1 week ago"

Author Filtering

# Single author (partial matching, case-insensitive)
git-digest . --authors alice

# Multiple authors
git-digest . --authors alice,bob,charlie

# Or using multiple flags
git-digest . --authors alice --authors bob

Summary Modes

# Chronological overview (default)
git-digest .

# Group by author
git-digest . --by-author

# Author-focused analysis with time filter
git-digest . --by-author --days 30 --authors "alice,bob"

Advanced Examples

# Debug mode with detailed logging
git-digest . --debug

# Multi-repo analysis for the last 2 weeks using OpenAI
git-digest ~/projects/* --days 14 --provider openai --debug

# Focus on recent work by specific team members
git-digest . --days 7 --authors "alice,bob,charlie" --by-author

# Last 25 commits across multiple repos
git-digest ~/frontend ~/backend --count 25

Command Line Options

Supported LLM Providers

Sample Output

Chronological Mode

==================================================
GIT DIGEST SUMMARY
==================================================
Based on the recent commits from your repository, here's what's been happening:

## Key Development Activities

**Feature Development**
- Implemented user authentication system with JWT tokens
- Added password reset functionality with email verification
- Created user profile management interface

**Bug Fixes & Improvements**
- Fixed memory leak in data processing pipeline
- Improved error handling in API endpoints
- Enhanced logging for better debugging

**Infrastructure & Maintenance**
- Updated dependencies to latest stable versions
- Added comprehensive test coverage for auth module
- Set up automated deployment pipeline

The development focus has been on strengthening the authentication system while maintaining code quality through better testing and monitoring.
==================================================

By-Author Mode

============================================================
GIT DIGEST SUMMARY - BY AUTHOR
============================================================
## Alice Johnson <alice@company.com> (15 commits)

Alice focused on the authentication system overhaul, implementing JWT-based login, password reset functionality, and user profile management. She also enhanced the API security by adding proper input validation and rate limiting. Her work established a solid foundation for user management features.

## Bob Smith <bob@company.com> (8 commits)

Bob concentrated on infrastructure improvements, updating the CI/CD pipeline and adding comprehensive test coverage. He also fixed several critical bugs in the data processing module and improved overall system performance through caching optimizations.

## Charlie Brown <charlie@company.com> (5 commits)

Charlie worked on frontend enhancements, improving the user interface for the new authentication features and fixing responsive design issues. He also contributed to the documentation updates and helped with code review processes.
============================================================

Environment Variables

All environment variables are optional but at least one LLM provider API key is required:

• OPENAI_API_KEY - OpenAI API key
• COHERE_API_KEY - Cohere API key
• ANTHROPIC_API_KEY - Anthropic API key

Error Handling

git-digest provides helpful error messages for common issues:

• Missing API keys: Clear instructions on which environment variable to set
• Invalid repositories: Identifies which paths are not valid git repositories
• Network issues: Graceful handling of API connectivity problems
• Empty results: Informative messages when no commits match your criteria

Contributing

1. Fork the repository
2. Create a feature branch: git checkout -b feature-name
3. Install development dependencies: uv sync --dev
4. Install pre-commit hooks: uv run pre-commit install
5. Make your changes and add tests
6. Run the test suite: uv run pytest
7. Run linting: uv run ruff check && uv run pyright
8. Pre-commit hooks will automatically run on commit, or manually: uv run pre-commit run --all-files
9. Submit a pull request

Development

# Clone and setup
git clone https://github.com/rafidka/git-digest.git
cd git-digest
uv sync --dev

# Install pre-commit hooks
uv run pre-commit install

# Run from source
uv run git-digest . --help

# Run tests
uv run pytest

# Format and lint
uv run ruff format
uv run ruff check
uv run pyright

# Run all pre-commit checks
uv run pre-commit run --all-files

Releasing

This project uses automated PyPI publishing via GitHub Actions. To create a new release:

1. Update the version in pyproject.toml
2. Commit the version change: git commit -am "Bump version to X.Y.Z"
3. Create a git tag: git tag vX.Y.Z
4. Push tag and commits: git push && git push --tags
5. Create a GitHub Release from the tag at https://github.com/rafidka/git-digest/releases/new
6. GitHub Actions will automatically:
   • Run all quality checks
   • Build the package
   • Publish to PyPI

Setting up PyPI Publishing (First Time)

To enable automatic PyPI publishing, you need to:

1. Set up PyPI Trusted Publishing:

   • Go to https://pypi.org/manage/account/publishing/
   • Add a new publisher for your-username/git-digest
   • Environment name: pypi

2. Create GitHub Environment:

   • Go to your repo Settings → Environments
   • Create environment named pypi
   • No additional protection rules needed (workflow uses OIDC)

License

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

Changelog

v0.7.0

• Renamed project from git-recap to git-digest
• Added comprehensive PyPI metadata
• Set up automated PyPI publishing workflow
• Enhanced project documentation

Previous Versions

• v0.5.2: Multi-repository analysis, author filtering, cross-repository coordination
• v0.1.0: Initial release with basic Git commit summarization