One policy, one catalog, three commands — plus refactor.
Linters, formatters, scanners, metric gates, and structural Python rules —
without hand-rolled CI glue.
Documentation · Usage guide · Changelog · Contributing
You start a Python project and quickly realize you need a pile of tools — linters, formatters, type checkers, secret scanners — each with its own config, install story, and CI glue. Before you write much code, you are maintaining a toolchain.
ShipGate replaces that sprawl with one project policy file and a metadata-driven catalog. Pick a suite once; run the same three commands locally, in CI, and in pre-commit. The wheel also ships refactor — AST rules for structural cleanup alongside catalog gates.
Requires Python 3.11–3.14 (prefer 3.13 for the full suite).
pip install shipgate # or: uv add --dev shipgate
shipgate init # scaffold .shipgate/ policy + configs
shipgate install # install tools for your suite
shipgate format --target . # apply formatters
shipgate check --target . # report-only quality gates
shipgate refactor check . # structural Python rules (JSON hits)Optional: pip install 'shipgate[server]' then shipgate serve --open for
the report UI. See Refactor
for fix, list, explain, and optional rule packs.
This README is the shortest path to a working project. For suites, policy, error formats, CI, gates, and the full tool catalog, use the documentation site.
| Guide | Contents |
|---|---|
| Usage | Commands, suites, error formats, CI, pre-commit |
| Refactor | Structural Python rules (check, fix, list, explain) |
| Configuration | Policy files, scopes, Radon metric gates |
| Tools | Bundled catalog and project extensions |
| Architecture | Layers and design decisions |
| Check flow | Tool YAML → shipgate check |
See CONTRIBUTING.md. Maintainer notes live locally in
AGENTS.md (not committed).
MIT — see LICENSE.