Skip to content

Commit fc494ed

Browse files
committed
build: add README to python pkg for setup.py
1 parent 1f4d6a7 commit fc494ed

1 file changed

Lines changed: 86 additions & 0 deletions

File tree

‎python/README.md‎

Lines changed: 86 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,86 @@
1+
# 📊 Git Commit Summary Tool
2+
3+
[![PyPI Version](https://img.shields.io/pypi/v/git-commit-summary.svg)](https://pypi.org/project/git-commit-summary/)
4+
[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5+
[![Python 3.6+](https://img.shields.io/badge/python-3.6+-blue.svg)](https://pypi.org/project/git-commit-summary/)
6+
[![PRs Welcome](https://img.shields.io/badge/PRs-welcome-brightgreen.svg)](http://makeapullrequest.com)
7+
8+
A powerful, high-performance CLI tool to summarize git commits with rich visual feedback.
9+
10+
> **Author**: Sai Annam (mr_ask_chay)
11+
> **Handle**: @otaku0304
12+
13+
---
14+
15+
## 🚀 Quick Start for Users (No Code Required)
16+
17+
You do **NOT** need to clone this repository to use the tool. Simply install it via pip:
18+
19+
```bash
20+
pip install git-commit-summary
21+
```
22+
23+
Once installed, the command `git-commit-summary` is available globally in your terminal. You can use it in any of your projects immediately.
24+
25+
### Usage
26+
```bash
27+
# 1. Go to your project folder
28+
cd my-cool-project
29+
30+
# 2. Run the summary command
31+
git show HEAD | git-commit-summary
32+
```
33+
34+
---
35+
36+
## 🛠️ For Developers (Contributing)
37+
38+
Clone this repository only if you want to contribute to the source code.
39+
40+
```bash
41+
git clone https://github.com/otaku0304/git-commit-summary.git
42+
cd git-commit-summary
43+
pip install -r requirements.txt
44+
```
45+
46+
---
47+
48+
## ✨ Features
49+
* **Rich UI**: Beautiful terminal output with colors and clear formatting.
50+
* **Smart Analysis**:
51+
* Tracks files changed and file types (e.g., .py, .js).
52+
* Calculates net changes (Added vs Removed).
53+
* Detects new functions across multiple languages (Python, JS, C++).
54+
* **Author Branding**: Displays author credentials and portfolio links.
55+
* **Security Focused**: Sanitized input handling and robust error management.
56+
* **No Heavy Dependencies**: Runs with standard library (uses `colorama` if available, falls back gracefully).
57+
58+
## 🔒 Security
59+
60+
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.
61+
62+
## 🧪 Example Output
63+
64+
```text
65+
╔══════════════════════════════════════════════════════════╗
66+
║ Git Commit Summary Tool ║
67+
║ Author: Sai Annam (mr_ask_chay / otaku0304) ║
68+
╚══════════════════════════════════════════════════════════╝
69+
70+
📊 Statistics:
71+
Files Changed : 2
72+
Lines Added : 140
73+
Lines Removed : 32
74+
Net Change : +108
75+
76+
📁 File Types:
77+
.py : 1
78+
.md : 1
79+
80+
✨ New Functions (2):
81+
+ detect_function
82+
+ print_banner
83+
```
84+
85+
---
86+
*Maintained with ❤️ by Sai Annam*

0 commit comments

Comments
 (0)