Skip to main content

A powerful CLI tool to summarize git commits with rich visual feedback.

Project description

๐Ÿ“Š Git Commit Summary Tool

License: MIT Python 3.6+ PRs Welcome

A powerful, high-performance CLI tool to summarize git commits with rich visual feedback.

Author: Sai Annam (mr_ask_chay)
Handle: @otaku0304


๐Ÿ“ฆ Installation

You can install this tool directly from the source to use it globally on your system.

# Clone the repository
git clone https://github.com/otaku0304/git-commit-summary.git
cd git-commit-summary

# Install globally
pip install .

Once installed, you can use it as a native git command!

# This now works anywhere in your terminal
git commit-summary

๐ŸŒŸ Previous Projects by Author


๐Ÿš€ Usage

If you installed it globally:

git show HEAD | git-commit-summary

Or run via python directly:

git show HEAD | python summary.py

โœจ Features

  • Rich UI: Beautiful terminal output with colors and clear formatting.
  • Smart Analysis:
    • Tracks files changed and file types (e.g., .py, .js).
    • Calculates net changes (Added vs Removed).
    • Detects new functions across multiple languages (Python, JS, C++).
  • Author Branding: Displays author credentials and portfolio links.
  • Security Focused: Sanitized input handling and robust error management.
  • No Heavy Dependencies: Runs with standard library (uses colorama if available, falls back gracefully).

๐Ÿ”’ Security

This tool uses sterile input processing from stdin. It does not execute external code or shell commands, ensuring your local environment remains secure against injection attacks from malicious diffs.

๐Ÿงช Example Output

โ•”โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•—
โ•‘ Git Commit Summary Tool                                  โ•‘
โ•‘ Author: Sai Annam (mr_ask_chay / otaku0304)              โ•‘
โ•šโ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•โ•

๐Ÿ“Š Statistics:
  Files Changed : 2
  Lines Added   : 140
  Lines Removed : 32
  Net Change    : +108

๐Ÿ“ File Types:
  .py           : 1
  .md           : 1

โœจ New Functions (2):
  + detect_function
  + print_banner

Maintained with โค๏ธ by Sai Annam

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_commit_summary-1.0.0.tar.gz (5.6 kB view details)

Uploaded Source

Built Distribution

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

git_commit_summary-1.0.0-py3-none-any.whl (6.3 kB view details)

Uploaded Python 3

File details

Details for the file git_commit_summary-1.0.0.tar.gz.

File metadata

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

File hashes

Hashes for git_commit_summary-1.0.0.tar.gz
Algorithm Hash digest
SHA256 41812fd3d64e9f24ffcb2aafa92d49b72216472f04858e8763097571f7539441
MD5 a9722cf461a8dc00172724fd38d9098b
BLAKE2b-256 78896d05716d86fd02b651563748bfa814359bce43bbe999fe697ee68b1f21db

See more details on using hashes here.

Provenance

The following attestation bundles were made for git_commit_summary-1.0.0.tar.gz:

Publisher: publish.yml on otaku0304/git-commit-summary

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_commit_summary-1.0.0-py3-none-any.whl.

File metadata

File hashes

Hashes for git_commit_summary-1.0.0-py3-none-any.whl
Algorithm Hash digest
SHA256 30b75b89208b2f5726da307f9c7c7c024afe8cd8eee4dfa25b45d0ee95ebfb84
MD5 c538e248764d1db4e519fe8bb138d158
BLAKE2b-256 675dc0ad7dc4dc1666e1ef8f2946c0a8ed94b2194108060c08aa7594b610ba19

See more details on using hashes here.

Provenance

The following attestation bundles were made for git_commit_summary-1.0.0-py3-none-any.whl:

Publisher: publish.yml on otaku0304/git-commit-summary

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