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.12.tar.gz (243.7 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.12-py3-none-any.whl (443.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: shipgate-0.1.12.tar.gz
  • Upload date:
  • Size: 243.7 kB
  • Tags: Source
  • Uploaded using 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}

File hashes

Hashes for shipgate-0.1.12.tar.gz
Algorithm Hash digest
SHA256 138fbab57f7fe180c89cc4efcb44824917a6dfda05a2d60a678a568bb3e04f3a
MD5 523d479f55a361901a9157ce0d040301
BLAKE2b-256 cca5cc1bff5a8e8d7190c3ee95ba0ac3046b59c1e61f39fd092f781ba00fa80a

See more details on using hashes here.

File details

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

File metadata

  • Download URL: shipgate-0.1.12-py3-none-any.whl
  • Upload date:
  • Size: 443.0 kB
  • Tags: Python 3
  • Uploaded using 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}

File hashes

Hashes for shipgate-0.1.12-py3-none-any.whl
Algorithm Hash digest
SHA256 d6f5f2b77a41b2908b1cfb2e59c81cb128e15fe528f7f9ab7600ca93bf46d608
MD5 44d9267b3772042d658a7e0944a5754e
BLAKE2b-256 020bd0fc8698213db2a5cb5c4fb519be5d7838a215d5c453be193e687928e34c

See more details on using hashes here.

Release history Release notifications | RSS feed

This release

0.1.12 This release

2 files

0.1.11

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