Skip to main content

Create a brag list of open source contributions

Project description

gitbrag

Create a brag list of open source contributions

Features

  • CLI: Command-line interface for generating reports
  • Web Interface: Browser-based interface with GitHub OAuth authentication
  • Public Data: Only accesses publicly available GitHub data
  • Caching: Redis-backed caching for performance
  • Flexible Filtering: Filter by date range and repository
  • Multiple Formats: Rich terminal output and web views

Installation

pip install gitbrag

Or run directly with uvx without installing:

uvx gitbrag list <username>

Quick Start

CLI

# List your contributions from the past year
gitbrag list your-username

# Or with date range
gitbrag list your-username --since 2024-12-14 --until 2025-12-14

Web Interface

Start the web interface with Docker Compose:

docker compose up

Then visit http://localhost and login with GitHub to generate your report.

See Web Interface Documentation for detailed setup instructions.

Configuration

Set your GitHub Personal Access Token:

export GITHUB_TOKEN="your_token_here"

Or create a .env file:

GITHUB_TOKEN=your_token_here

CLI Usage

List pull requests for a GitHub user:

gitbrag list <username> [OPTIONS]

Options

  • --since DATE - Start date (ISO format, default: 365 days ago)
  • --until DATE - End date (ISO format, default: today)
  • --include-private - Include private repositories
  • --show-urls - Display PR URLs in output
  • --show-star-increase - Display repository star increases during the filtered period
  • --sort FIELD[:ORDER] - Sort by field (can be used multiple times)
    • Valid fields: repository, state, created, merged, title, stars (requires --show-star-increase)
    • Valid orders: asc, desc (default: desc)

Examples

Show all PRs from the last year:

gitbrag list tedivm

Show PRs from a specific date range:

gitbrag list tedivm --since 2024-12-14 --until 2025-12-14

Sort by repository, then by merge date:

gitbrag list tedivm --since 2024-12-14 --until 2025-12-14 --sort repository --sort merged:desc

Show repository star increases during the filtered period:

gitbrag list tedivm --since 2024-12-14 --until 2025-12-14 --show-star-increase

Example output:

                                           Pull Requests
┏━━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━┳━━━━━━━━━━━━━━━━━━━━━━━━━━━┳━━━━━━━━┳━━━━━━━━━━━━┳━━━━━━━━━━━━┓
┃ Repository                 ┃ PR # ┃ Title                     ┃ State  ┃ Created    ┃ Merged     ┃
┡━━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━╇━━━━━━━━━━━━━━━━━━━━━━━━━━━╇━━━━━━━━╇━━━━━━━━━━━━╇━━━━━━━━━━━━┩
│ TerraformInDepth/terrafor… │ 1    │ Version Upgrades          │ merged │ 2025-04-05 │ 2025-04-05 │
│ TerraformInDepth/tofupy    │ 1    │ Update version, test      │ merged │ 2025-04-05 │ 2025-04-05 │
│                            │      │ range of python versions  │        │            │            │
│ TerraformInDepth/tofupy    │ 5    │ Improve Documentation     │ merged │ 2025-08-02 │ 2025-08-02 │
│ tedious/JShrink            │ 149  │ Update PHP versions in CI │ merged │ 2025-11-20 │ 2025-11-20 │
│                            │      │ workflow                  │        │            │            │
│ tedious/Stash              │ 429  │ Update tested versions of │ merged │ 2024-12-18 │ 2024-12-18 │
│                            │      │ php                       │        │            │            │
│ tedious/Stash              │ 435  │ Update PHP versions in    │ open   │ 2025-11-20 │ -          │
│                            │      │ GitHub Actions workflow   │        │            │            │
│ tedivm/paracelsus          │ 39   │ Lock down pydot to v3     │ merged │ 2025-08-20 │ 2025-08-20 │
│ tedivm/paracelsus          │ 44   │ Run test suite against    │ merged │ 2025-10-10 │ 2025-10-10 │
│                            │      │ 3.14                      │        │            │            │
│ tedivm/paracelsus          │ 47   │ Drop tests and docs from  │ merged │ 2025-11-22 │ 2025-11-22 │
│                            │      │ wheel build               │        │            │            │
│ tedivm/paracelsus          │ 52   │ Switch delimiter for      │ merged │ 2025-12-14 │ 2025-12-14 │
│                            │      │ column parameters in      │        │            │            │
│                            │      │ Mermaid                   │        │            │            │
│ tedivm/paracelsus          │ 53   │ Support PyDot v3 and v4   │ merged │ 2025-12-14 │ 2025-12-14 │
│ tedivm/quasiqueue          │ 15   │ Run Test Suite against    │ merged │ 2025-10-10 │ 2025-10-10 │
│                            │      │ Python 3.14               │        │            │            │
│ tedivm/robs_awesome_pytho… │ 15   │ fix pytest workflow       │ merged │ 2025-04-11 │ 2025-04-11 │
│                            │      │ rendering                 │        │            │            │
│ tedivm/robs_awesome_pytho… │ 16   │ Add template test suite   │ merged │ 2025-04-11 │ 2025-04-11 │
│ tedivm/robs_awesome_pytho… │ 19   │ Caching, Testing, and     │ merged │ 2025-11-27 │ 2025-11-27 │
│                            │      │ Documentation Updates     │        │            │            │
│ tedivm/skysnoop            │ 4    │ Create a high level       │ merged │ 2025-11-30 │ 2025-11-30 │
│                            │      │ unified client            │        │            │            │
└────────────────────────────┴──────┴───────────────────────────┴────────┴────────────┴────────────┘

Total: 16 pull requests

Developer Documentation

Comprehensive developer documentation is available in docs/dev/ covering testing, configuration, deployment, and all project features.

Quick Start for Developers

# Install development environment
make install

# Start services with Docker
docker compose up -d

# Run tests
make tests

# Auto-fix formatting
make chores

See the developer documentation for complete guides and reference.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

gitbrag-0.3.2.tar.gz (327.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

gitbrag-0.3.2-py3-none-any.whl (148.3 kB view details)

Uploaded Python 3

File details

Details for the file gitbrag-0.3.2.tar.gz.

File metadata

  • Download URL: gitbrag-0.3.2.tar.gz
  • Upload date:
  • Size: 327.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gitbrag-0.3.2.tar.gz
Algorithm Hash digest
SHA256 977154206e39b654b6cb1b8cbf9b6352ebabeb76a74c6b8d5b2ed5bec6c60ed4
MD5 2720eafa5284ed489f96947ca192f492
BLAKE2b-256 f6a4d3528b6e9f1dd821453f650ba862459d8fbc4f4fafb3d9009f6860646778

See more details on using hashes here.

Provenance

The following attestation bundles were made for gitbrag-0.3.2.tar.gz:

Publisher: pypi.yaml on tedivm/gitbrag

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

Details for the file gitbrag-0.3.2-py3-none-any.whl.

File metadata

  • Download URL: gitbrag-0.3.2-py3-none-any.whl
  • Upload date:
  • Size: 148.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.13.7

File hashes

Hashes for gitbrag-0.3.2-py3-none-any.whl
Algorithm Hash digest
SHA256 d05f04d821a390204753529e5352447da6484651caf2feb8cee8080b60663723
MD5 6d76fd22fea71b3f2de66213a5b52dc3
BLAKE2b-256 b3acd171ba385805790fbdd9552ef92164063df09918443b06a2c06b1ca23664

See more details on using hashes here.

Provenance

The following attestation bundles were made for gitbrag-0.3.2-py3-none-any.whl:

Publisher: pypi.yaml on tedivm/gitbrag

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page