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.
Quick start
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.
Documentation
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 |
Contributing
See CONTRIBUTING.md. Maintainer notes live locally in
AGENTS.md (not committed).
License
MIT — see LICENSE.
1 maintainer
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file shipgate-0.1.7.tar.gz.
File metadata
- Download URL: shipgate-0.1.7.tar.gz
- Upload date:
- Size: 232.3 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.0 {"installer":{"name":"uv","version":"0.12.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
4f95238c40ee6d7d595b51ce43de033761b67300df215d768bc702797b16b307
|
|
| MD5 |
06fb3f0d7f1dae2a3b899a8fb9c7d9a2
|
|
| BLAKE2b-256 |
c6a3d5cdaef19d63cbfa43989bdd79c7922e58f5d99efa366808eb829b24df52
|
File details
Details for the file shipgate-0.1.7-py3-none-any.whl.
File metadata
- Download URL: shipgate-0.1.7-py3-none-any.whl
- Upload date:
- Size: 429.8 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
uv/0.12.0 {"installer":{"name":"uv","version":"0.12.0","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
47e3f3e7e4de2fbdee4e16244fba562acc53b4bb105135fbfd0aa65f4914d559
|
|
| MD5 |
4fb2f199d26323025cf20528d4e1c1ea
|
|
| BLAKE2b-256 |
55647271bb9b5660ed8e9f8d75756b79b2439a07f45d34322702f37fff0d0f9f
|
