Skip to main content

AI-powered Git patch assistant with HTML report generation.

Project description

PatchMind Banner

🧠 PatchMind

Run PatchMind Report PyPI - Version 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.4.tar.gz (1.7 MB 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.4-py3-none-any.whl (16.3 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: patchmind-0.1.4.tar.gz
  • Upload date:
  • Size: 1.7 MB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/6.1.0 CPython/3.12.9

File hashes

Hashes for patchmind-0.1.4.tar.gz
Algorithm Hash digest
SHA256 8a4987c02d843aff9b345918d04c692878330bf75e3b33b50befda6fa3892c12
MD5 6a6b8fa0ac0331d4ca04ea1aafd48709
BLAKE2b-256 f0162dd2e12a3e160c58f6fa0468d91b717e59c2d8e0b908aef25e4367d913d0

See more details on using hashes here.

Provenance

The following attestation bundles were made for patchmind-0.1.4.tar.gz:

Publisher: publish.yml on Darkstar420/patchmind

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

File details

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

File metadata

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

File hashes

Hashes for patchmind-0.1.4-py3-none-any.whl
Algorithm Hash digest
SHA256 3c1fc4b0396fcbdbf5bd31b5bba90a0802cec5b9395b98cde81403849c96ced2
MD5 c2e5753deebc8176e94ccf0ebf6a2047
BLAKE2b-256 6153d33b75222e242d4e1d86a8fdab7b3f14b5401996274d9054fdaa8d5c80a7

See more details on using hashes here.

Provenance

The following attestation bundles were made for patchmind-0.1.4-py3-none-any.whl:

Publisher: publish.yml on Darkstar420/patchmind

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