Skip to main content

AI-powered Git patch assistant with HTML report generation.

Project description

Run PatchMind Report PyPI License

๐Ÿง  PatchMind

PatchMind is a modular Python-based framework that monitors a local Git repository and generates intelligent HTML reports with change summaries, tree views, file timelines, risk scoring, and more. Designed for developers who want lightweight tools to keep their codebase clean and up to date โ€” without another bloated assistant.


๐Ÿš€ Features

  • ๐Ÿ” Patch-level file change detection
  • ๐ŸŒณ Tree-based visualization of modified files
  • ๐Ÿ“… File history timeline with author and commit metadata
  • โš ๏ธ Impact score and risk analysis
  • ๐Ÿ‘ค Line-level blame summary
  • ๐Ÿงพ One-click HTML report generation via CLI

๐Ÿ“ธ Sample Output

PatchMind HTML Report Sample


โš™๏ธ Installation

git clone https://github.com/your-user/patchmind.git
cd patchmind
pip install -r requirements.txt
๐Ÿ› ๏ธ Usage
bash
Copy
Edit
python cli/main.py --report
This command will analyze your Git repo and generate a standalone HTML report as patchmind_report.html.

๐Ÿงฑ Project Structure
arduino
Copy
Edit
patchmind/
โ”œโ”€โ”€ cli/
โ”‚   โ””โ”€โ”€ main.py
โ”œโ”€โ”€ core/
โ”‚   โ”œโ”€โ”€ engine.py
โ”‚   โ”œโ”€โ”€ reporter.py
โ”‚   โ”œโ”€โ”€ summarizer.py
โ”‚   โ”œโ”€โ”€ insight.py
โ”‚   โ””โ”€โ”€ visualizer.py
โ”œโ”€โ”€ tests/
โ”‚   โ””โ”€โ”€ test_reporter.py
โ”œโ”€โ”€ docs/
โ”‚   โ””โ”€โ”€ patchmind_report_sample.png
โ”œโ”€โ”€ config.yaml
โ”œโ”€โ”€ requirements.txt
โ””โ”€โ”€ README.md
๐Ÿงช Testing
bash
Copy
Edit
pytest -q
Unit tests are located in tests/test_reporter.py and validate HTML report generation using mocks.

๐Ÿ“Œ Why PatchMind?
โœ… Zero-setup, fast HTML output
โœ… Clear, visual insight into how your repo evolves
โœ… Built by devs, for devs โ€” no cloud syncing, no bloat

๐Ÿ“„ License
Apache 2.0 โ€” free to use, modify, and build on.

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

patchmind-0.1.0.tar.gz (16.1 kB view details)

Uploaded Source

Built Distribution

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

patchmind-0.1.0-py3-none-any.whl (16.0 kB view details)

Uploaded Python 3

File details

Details for the file patchmind-0.1.0.tar.gz.

File metadata

  • Download URL: patchmind-0.1.0.tar.gz
  • Upload date:
  • Size: 16.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.18

File hashes

Hashes for patchmind-0.1.0.tar.gz
Algorithm Hash digest
SHA256 9c88fbc4f8982945a5f379ee3857d67fc4ca947f30fb7635d00d4a19a1067a73
MD5 f70cccba83ef452caa7ad55d74827575
BLAKE2b-256 8176f806c3c1d97a6f3db7b95116b483dadd6efdc5729b7a0b49f1590ce35c56

See more details on using hashes here.

File details

Details for the file patchmind-0.1.0-py3-none-any.whl.

File metadata

  • Download URL: patchmind-0.1.0-py3-none-any.whl
  • Upload date:
  • Size: 16.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.10.18

File hashes

Hashes for patchmind-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 dfdb7093dcad05453446dc3c6359ba0f12fd8b64269dcb1ce62bb13fea44a585
MD5 afbdbe161f48f8afe4cfea352122f343
BLAKE2b-256 730e4684d86834f5bf7ffbdea7a609b93970fdfd3e736b48411731da0c77c44c

See more details on using hashes here.

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