Skip to main content

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

Project description

๐Ÿ“Š Git Commit Summary Tool

PyPI Version 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


๐Ÿš€ Quick Start for Users (No Code Required)

You do NOT need to clone this repository to use the tool. Simply install it via pip:

pip install git-commit-summary

Once installed, the command git-commit-summary is available globally in your terminal. You can use it in any of your projects immediately.

Usage

# 1. Go to your project folder
cd my-cool-project

# 2. Run the summary command
git show HEAD | git-commit-summary

๐Ÿ› ๏ธ For Developers (Contributing)

Clone this repository only if you want to contribute to the source code.

git clone https://github.com/otaku0304/git-commit-summary.git
cd git-commit-summary
pip install -r requirements.txt

โœจ 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.1.tar.gz (4.9 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.1-py3-none-any.whl (5.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: git_commit_summary-1.0.1.tar.gz
  • Upload date:
  • Size: 4.9 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.1.tar.gz
Algorithm Hash digest
SHA256 03be32ec405b470b9916dce16111bbc18be4f7d6d0ad85211a3d0ce96d86e5e7
MD5 c29ddc3287fb672cf12ccace4603c61f
BLAKE2b-256 f22b01e636c05ba0a0db77e38b7efdcac5cb1bd356d846684946ca40ad2b3517

See more details on using hashes here.

Provenance

The following attestation bundles were made for git_commit_summary-1.0.1.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.1-py3-none-any.whl.

File metadata

File hashes

Hashes for git_commit_summary-1.0.1-py3-none-any.whl
Algorithm Hash digest
SHA256 25f8930c0c6c02ba35bc9cbb56c40e2a0b6f482f41ace8bcaa66f75cb11826dd
MD5 30cdebeb2f0fc0222921375222b1be23
BLAKE2b-256 5fd5869aed48f250a66055fdff5497222240df39eeed7aec78a73cb665ad0661

See more details on using hashes here.

Provenance

The following attestation bundles were made for git_commit_summary-1.0.1-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