Skip to main content

AI-powered Git patch assistant with HTML report generation.

Project description

PatchMind Banner

🧠 PatchMind

Run PatchMind Report Publish to PyPI PyPI License: Apache-2.0 GitHub stars


PatchMind is a modular Python CLI tool for Git repositories that generates smart, visual HTML reports.
It captures patch-level diffs, tree views, file history timelines, risk scoring, and more — all locally.

No cloud. No bloat. Just clean insight.


🚀 Key Features

  • 🔍 Detects file-level and line-level changes across commits
  • 🌳 Tree-based visualization of modified paths
  • 📅 File timeline view with authorship and metadata
  • ⚠️ Risk and impact scoring per file
  • 👤 Inline blame summaries
  • 📄 Clean, standalone HTML output
  • ⚙️ Fully CLI-driven — automate in CI/CD

📸 Sample Output

PatchMind HTML Report Sample


📦 Installation

Install from PyPI:

pip install patchmind

Or install manually:

git clone https://github.com/Darkstar420/patchmind.git
cd patchmind
pip install -r requirements.txt

🧪 Usage

Generate an HTML report from the root of any Git repo:

python cli/main.py --report

The output will be saved as patchmind_report.html in the project root.


📂 Project Layout

patchmind/
├── cli/               # CLI entrypoint
├── core/              # Core analysis engine
├── tests/             # Unit tests
├── docs/              # Sample reports and images
├── config.yaml        # Config (optional)
├── requirements.txt
└── README.md

🧪 Run Tests

pytest -q

Unit tests live in tests/ and validate key functionality, including mock Git data and report rendering.


💡 Why Use PatchMind?

✅ No setup required – run it instantly ✅ See what's changing, where, and why ✅ Stay ahead of technical debt ✅ Built for devs who want insight — not overhead


📄 License

Licensed under the Apache 2.0 License — free to use, modify, and distribute.

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.1.tar.gz (16.7 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.1-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for patchmind-0.1.1.tar.gz
Algorithm Hash digest
SHA256 811bf9350ab5ba682fe71c193a1eace57e31af8ddb13412bf26dcd028f7595eb
MD5 d05da5c87118e767c7ce66679b859108
BLAKE2b-256 4b752653910bbae920bcbfc9287739a196d00967fe709372efb9c07ed3338915

See more details on using hashes here.

File details

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

File metadata

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

File hashes

Hashes for patchmind-0.1.1-py3-none-any.whl
Algorithm Hash digest
SHA256 3814a2a6728d93643e39c49cc86c9df3c2d5d98fd20e8760c06b47da50d1cfed
MD5 3ad5f4b6b456d1de6f97e88275fa5c85
BLAKE2b-256 a2228967cc6a927f2ef5a296e7b7b368de866ee8b004609643b036b128b29119

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