ssot-contracts 0.2.18.dev1

Canonical schemas, templates, manifests, and generated Python contract artifacts for SSOT.

🔷 ssot-contracts

Canonical schemas, templates, manifests, and generated contract metadata for SSOT.

ssot-contracts is the canonical artifact package for SSOT.

It ships machine-readable schemas, registry templates, upstream-derived packaged ADR/spec manifests, and generated Python metadata that other SSOT packages consume at runtime.

What this package owns

• JSON Schemas for registries, reports, graph exports, and snapshots
• Packaged registry templates such as registry.minimal.json and registry.full.json
• Immutable packaged ADR and spec document manifests derived from the upstream .ssot/registry.json ssot-origin inventory
• Generated Python contract metadata used by CLI and TUI packages

When to use this package

Use ssot-contracts when you want:

• packaged schemas and templates without the full CLI
• a stable place to load SSOT manifests and contract metadata from Python
• the artifact layer consumed by ssot-registry, ssot-cli, ssot-conformance, ssot-tui, ssot-views, and ssot-codegen

Use another package when you want:

• ssot-registry for core runtime APIs and registry mutation/validation flows
• ssot-cli for command-line workflows
• ssot-tui for terminal UI browsing
• ssot-views for reusable derived report and graph builders
• ssot-codegen to regenerate contract-side metadata outputs

Install

python -m pip install ssot-contracts

For local development from this repository:

python -m pip install -e pkgs/ssot-contracts

Shipped artifacts

This package currently includes:

• schemas under ssot_contracts.schema
• registry templates under ssot_contracts.templates
• packaged ADR manifests and JSON files under ssot_contracts.templates.adr
• packaged spec manifests and JSON files under ssot_contracts.templates.specs
• generated Python metadata under ssot_contracts.generated.python

Representative schemas include:

• registry.schema.json
• validation.report.schema.json
• certification.report.schema.json
• graph.export.schema.json
• boundary.snapshot.schema.json
• release.snapshot.schema.json
• published.snapshot.schema.json

Programmatic usage

Load contract metadata:

from ssot_contracts import CONTRACT_DATA

print(CONTRACT_DATA["schema_version"])
print(CONTRACT_DATA["output_formats"])

Load a packaged document manifest:

from ssot_contracts import load_document_manifest

adr_manifest = load_document_manifest("adr")
spec_manifest = load_document_manifest("spec")
print(adr_manifest[0]["id"])
print(spec_manifest[0]["id"])

List available schema files or load one as text:

from ssot_contracts import list_schema_names, load_schema_text

print(list_schema_names())
schema_text = load_schema_text("registry.schema.json")

Read packaged document bodies:

from ssot_contracts import read_packaged_document_text

text = read_packaged_document_text("adr", "ADR-0600-canonical-json-registry.yaml")
print(text.splitlines()[0])

Generated metadata

Generated Python modules currently include:

• generated.python.cli_metadata
• generated.python.tui_metadata
• generated.python.ids
• generated.python.enums

These modules provide shared constants such as output formats, entity section labels, and identifier prefixes. They are intended to be imported by other SSOT packages rather than edited by hand.

Package relationships

• Package type: artifact and contract package
• Depends on: standard library only, plus tomli on Python earlier than 3.11
• Consumed by: ssot-registry, ssot-cli, ssot-conformance, ssot-tui, ssot-views, ssot-codegen

If you need the canonical packaged schemas and manifests, install this package. It is the lowest-level reusable contract layer in the workspace.