Metadata-Version: 2.4
Name: scrutin
Version: 0.1.3
Summary: Local pre-commit review briefs from your git diff — scrutinize changes, stage, and commit with confidence
Author: Scrutin contributors
License-Expression: MIT
Project-URL: Homepage, https://github.com/pramod5551/scrutin
Project-URL: Documentation, https://github.com/pramod5551/scrutin/blob/main/docs/USER_GUIDE.md
Project-URL: Repository, https://github.com/pramod5551/scrutin
Project-URL: Issues, https://github.com/pramod5551/scrutin/issues
Keywords: git,code-review,pull-request,pre-commit,developer-tools,diff
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Version Control :: Git
Requires-Python: >=3.11
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: fastapi>=0.115.0
Requires-Dist: uvicorn[standard]>=0.32.0
Requires-Dist: pydantic>=2.9.0
Requires-Dist: pydantic-settings>=2.6.0
Requires-Dist: httpx>=0.27.0
Requires-Dist: python-dotenv>=1.0.0
Dynamic: license-file

# Scrutin

**Review local git changes before you commit** — risk highlights, file diffs, stage/unstage, and commit from the **browser** or **VS Code / Cursor**. Everything runs on your machine.

| Audience | Documentation |
|----------|----------------|
| **Users** (install & daily use) | [docs/USER_GUIDE.md](docs/USER_GUIDE.md) |
| **Docker** (no Python on the host) | [docs/DOCKER.md](docs/DOCKER.md) |
| **Contributors** (clone, test, pull requests) | [docs/CONTRIBUTING.md](docs/CONTRIBUTING.md) |

---

## Quick start (users)

**Python**

```bash
pip install scrutin
cd your-project
scrutin serve
```

Open **http://127.0.0.1:8787** → set **Repository** to your repo path → **Detect repo** → **Refresh brief**.

**Docker** (no Python)

```bash
cd your-project
docker pull pramod5551/scrutin:latest
docker run --rm -p 8787:8787 -v "$(pwd):/workspace:rw" pramod5551/scrutin:latest
```

Open **http://127.0.0.1:8787** → Repository: **`/workspace`**.

**VS Code / Cursor**

Install the **Scrutin** extension from the Marketplace, run `pip install scrutin` (or use Docker on port 8787). Open the **Scrutin** activity bar → **Brief**.

Details: [docs/USER_GUIDE.md](docs/USER_GUIDE.md).

---

## Contributing

We welcome pull requests. Fork the repo, set up locally, run tests, and open a PR — see **[docs/CONTRIBUTING.md](docs/CONTRIBUTING.md)**.

---

## License

MIT — [LICENSE](LICENSE)
