Skip to main content

ShipGate — policy-first quality gates for Python projects

PyPI version Python versions License: MIT Documentation

One policy, one catalog, three commands — plus refactor.
Linters, formatters, scanners, metric gates, and structural Python rules — without hand-rolled CI glue.

Documentation · Quick start · 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). On 3.14, Semgrep and deadcode skip with an explicit requires_python message instead of crashing.

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 — start at Quick start.

Guide Contents
Quick start Init → install → format → check → refactor
Usage Suites, error formats, CI, pre-commit, report UI
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.

Metadata

Release files for shipgate 0.1.12

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for shipgate 0.1.12
File Size Uploaded Provenance
shipgate-0.1.12.tar.gz 243.7 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for shipgate 0.1.12
File Interpreter ABI Platform
shipgate-0.1.12-py3-none-any.whl Python 3 none any Details

Total release size: 686.8 kB

Release files / shipgate-0.1.12.tar.gz

Download URL shipgate-0.1.12.tar.gz
Size 243.7 kB
Tags Source
SHA-256 checksum
How to use checksums
138fbab57f7fe180c89cc4efcb44824917a6dfda05a2d60a678a568bb3e04f3a
BLAKE2b-256 checksum
How to use checksums
cca5cc1bff5a8e8d7190c3ee95ba0ac3046b59c1e61f39fd092f781ba00fa80a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","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}

Release files / shipgate-0.1.12-py3-none-any.whl

Download URL shipgate-0.1.12-py3-none-any.whl
Size 443.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
d6f5f2b77a41b2908b1cfb2e59c81cb128e15fe528f7f9ab7600ca93bf46d608
BLAKE2b-256 checksum
How to use checksums
020bd0fc8698213db2a5cb5c4fb519be5d7838a215d5c453be193e687928e34c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.9 {"installer":{"name":"uv","version":"0.12.9","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}

Security for shipgate 0.1.12

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page