Skip to main content

A compact terminal heatmap showing one year of Git commits (like GitHub contributions, but with compact bars instead of squares, to fit into a smaller terminal window)

Project description

git-year

A compact terminal heatmap showing one year of Git commits — similar to GitHub’s contribution graph, but optimized for small terminal windows using minimal vertical bars instead of squares.

Perfect for developers who want a clean, unobtrusive activity overview directly inside the terminal.


Features

  • Shows the past year of commit activity (today back to the same date last year) for the current Git repo
  • Jump to any calendar year with --year 2024 (auto-stops at today if the year is still in progress)
  • Choose Monday or Sunday as the calendar week start and keep the preference across reboots
  • Green intensity gradient based on commit volume
  • Compact vertical bars (|) instead of large squares — fits even tiny terminals
  • Zero dependencies (pure Python + Git)
  • 256-color ANSI output with dark-mode-friendly palette
  • Highlights the current weekday
  • Works in macOS, Linux, Windows Terminal, VS Code terminal, Git Bash
  • Graceful message if run outside a Git repo
  • Ready for PyPI (pip install git-year)

Installation

bash
pip install git-year

Usage

Simply run from inside a Git repository:

git-year

You’ll see a compact 7×52 bar heatmap covering the past year up to today:

M ||||||||||||||||||||||||||||||
T ||||||||||||||||||||||||||||||
W ||||||||||||||||||||||||||||||
T ||||||||||||||||||||||||||||||
F ||||||||||||||||||||||||||||||
S ||||||||||||||||||||||||||||||
S ||||||||||||||||||||||||||||||
  • Rows = weekdays (Mon–Sun)
  • Columns = weeks (52 total) covering the trailing year’s timeline (same date last year → today)
  • Color intensity = commit count
  • The current day label is highlighted in yellow

Show the installed version:

git-year --version

Focus on a specific calendar year (Jan 1 → Dec 31, or today if it’s still the current year):

git-year --year 2024

Choose the start of the week (case-insensitive, saved to ~/.config/git-year/config.toml on Linux/macOS or %APPDATA%\git-year\config.toml on Windows):

git-year --week-start sunday
git-year --week-start Mon

When you try to peek into a future year you’ll get a playful reminder:

Trying to look into the future? ;)

Requirements

  • Python 3.8+
  • Git available in PATH
  • A terminal with ANSI color support (all modern terminals)
  • On legacy cmd.exe ANSI colors may fall back to monochrome

Contributing

Contributions are welcome! Ideas, issues, and pull requests are appreciated.


License

MIT License Copyright (c) 2025 Serge Velbovets


Enjoy your terminal-native Git activity graph without leaving the shell — git-year keeps your development rhythm visible, simple, and elegant.

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

git_year-0.4.1.tar.gz (6.0 kB view details)

Uploaded Source

Built Distribution

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

git_year-0.4.1-py3-none-any.whl (6.7 kB view details)

Uploaded Python 3

File details

Details for the file git_year-0.4.1.tar.gz.

File metadata

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

File hashes

Hashes for git_year-0.4.1.tar.gz
Algorithm Hash digest
SHA256 b9086d79f62710201df89b4d6bfe3af6ad8211af6cbf42260075db7e9912a96c
MD5 f316630294301496836f9ced7e3ea292
BLAKE2b-256 e46da9ae2f918b1511e6d8a741053e3de2890d4e31be2a2e1446683308ef03d9

See more details on using hashes here.

Provenance

The following attestation bundles were made for git_year-0.4.1.tar.gz:

Publisher: publish-pypi.yml on velbix/git-year

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

File details

Details for the file git_year-0.4.1-py3-none-any.whl.

File metadata

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

File hashes

Hashes for git_year-0.4.1-py3-none-any.whl
Algorithm Hash digest
SHA256 f72b19b5d623a95c8483d33f54f5c0e7480ed551ce72078a64364bbf823d41f6
MD5 e793e6a7c159a27701142782d2cc2d36
BLAKE2b-256 42ab44b1547b6682daad81b9f77eb76907375281c49a782c17026de1009f4a96

See more details on using hashes here.

Provenance

The following attestation bundles were made for git_year-0.4.1-py3-none-any.whl:

Publisher: publish-pypi.yml on velbix/git-year

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