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.

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

shipgate-0.1.11.tar.gz (242.8 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

shipgate-0.1.11-py3-none-any.whl (441.8 kB view details)

Uploaded Python 3

File details

Details for the file shipgate-0.1.11.tar.gz.

File metadata

  • Download URL: shipgate-0.1.11.tar.gz
  • Upload date:
  • Size: 242.8 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.4 {"installer":{"name":"uv","version":"0.12.4","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

Hashes for shipgate-0.1.11.tar.gz
Algorithm Hash digest
SHA256 44b0ea799340fde1f80bd03911793ef6b5896d69e3769f352b1c6855aec0e2e6
MD5 470b6fac65c8a5cb0043a28ba34c58ff
BLAKE2b-256 65a6bfa89ee50f0f4015bc74760188d29d6b834297471f76e0b08c7041d83cc1

See more details on using hashes here.

File details

Details for the file shipgate-0.1.11-py3-none-any.whl.

File metadata

  • Download URL: shipgate-0.1.11-py3-none-any.whl
  • Upload date:
  • Size: 441.8 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: uv/0.12.4 {"installer":{"name":"uv","version":"0.12.4","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

Hashes for shipgate-0.1.11-py3-none-any.whl
Algorithm Hash digest
SHA256 80cf0bd54d29c5f746f3e223f43aca67fc8a2b588fd827ed957e4290e583e106
MD5 7ca6745f451b22d1a9c60dc87feaa293
BLAKE2b-256 97166cc01fbcea1555cd0090e2aedee806fb610075e490a0869d2791e6d61ca2

See more details on using hashes here.

Release history Release notifications | RSS feed

0.1.12

2 files

This release

0.1.11 This release

2 files

0.1.10

2 files

0.1.9

2 files

0.1.8

2 files

0.1.7

2 files

0.1.6

2 files

0.1.5

2 files

0.1.4

2 files

0.1.3

2 files

0.1.2

2 files

0.1.1

2 files

0.1.0

2 files

0.0.2

2 files

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