Skip to main content

OpenFrame Microservice Suite - developer tooling meta-package. Install tools by name or group.

Project description

openframe-tooling

A metadata-only package that provides named install shortcuts for the openframe-tooling ecosystem. Install one tool, or everything — all with a single pip install command.


Install surface

Individual tools

pip install openframe-tooling[schemas]   # openframe-schemas — cross-service schema governance
pip install openframe-tooling[cli]       # openframe-cli     — service scaffolding
pip install openframe-tooling[docs]      # openframe-docs    — doc-truth CI

Everything

pip install openframe-tooling[all]       # all tools in the ecosystem

What each tool does

  • openframe-schemas — publishes @contract-decorated Pydantic models (marked via openframe.core.schemas.contract) to a versioned, file-based registry and detects breaking changes between versions. Ships a CLI (openframe-schemas publish / check) for use as a CI gate.
  • openframe-cli — service scaffolding via Copier templates. Generates a full hexagonal-architecture OpenFrame service — domain, ports, service, adapter, ApplicationBootstrap wiring, and tests/test_architecture.py enforcing the boundary — from a single openframe new service command. openframe check runs architecture/pins/contracts checks in CI.
  • openframe-docs — doc-truth CI: derives documentation claims from source rather than trusting prose. Three independent checkers — check-pins (README version claims vs. real package version), check-sigs (README code-block calls vs. real installed signatures), and check-imports (README imports vs. what actually resolves) — each usable standalone as a CI gate.

Note: as of 0.1.0, all three tools — openframe-schemas, openframe-cli, and openframe-docs — are published.


Versioning

Each tool is versioned independently and published to PyPI under its own name (e.g. openframe-schemas). This meta-package pins each one to its own major-version range (see [project.optional-dependencies] in pyproject.toml), so patch and minor releases are picked up automatically on pip install --upgrade. Only a major version bump in an individual tool requires a meta-package update.

When a new tool is added to the ecosystem, only this pyproject.toml changes — one new line in [project.optional-dependencies] and an update to the all group. No other file in the monorepo is touched.

Project details


Download files

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

Source Distribution

openframe_tooling-0.1.0.tar.gz (3.1 kB view details)

Uploaded Source

Built Distribution

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

openframe_tooling-0.1.0-py3-none-any.whl (2.7 kB view details)

Uploaded Python 3

File details

Details for the file openframe_tooling-0.1.0.tar.gz.

File metadata

  • Download URL: openframe_tooling-0.1.0.tar.gz
  • Upload date:
  • Size: 3.1 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.12

File hashes

Hashes for openframe_tooling-0.1.0.tar.gz
Algorithm Hash digest
SHA256 ee2eadcf740a6ee1cfdc834baa7629894a9835c0e3085912eda58986d462c5d1
MD5 f97e44903a5ee9f594c460c430dd3748
BLAKE2b-256 8a8acbc5420d9ca6193aee9bf4c68ee7005c929e95183285ef3126c4f8cfd265

See more details on using hashes here.

File details

Details for the file openframe_tooling-0.1.0-py3-none-any.whl.

File metadata

File hashes

Hashes for openframe_tooling-0.1.0-py3-none-any.whl
Algorithm Hash digest
SHA256 5e6a58103a40734f6731110b751177bcd1d6eaabb262adcaffe31a04c4793da2
MD5 b97cd2df560d3fd13b4f1a110e29400c
BLAKE2b-256 32b97cb7ca94428bc0637d9220dbff1e123093ed5fd4cc32c3ce0ece3fada732

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page