Skip to main content

🔷 ssot-codegen

Development-time generators for SSOT contract-side metadata artifacts.

PyPI version Supported Python versions Downloads Repository hits Discord schema_version 0.8.0 Migration coverage 14/14

ssot-codegen contains generators for SSOT contract-side metadata artifacts.

It is a development-oriented package used to materialize generated JSON and Python outputs from the canonical contract layer. It is not the main runtime entry point for end users.

What this package owns

  • The ssot-codegen console command
  • Generation of Python-side metadata artifacts derived from ssot-contracts
  • Development-time regeneration of CLI and TUI metadata outputs

When to use this package

Use ssot-codegen when you want:

  • to regenerate packaged metadata artifacts during development
  • to inspect the current generated contract index, CLI metadata, or TUI metadata
  • a small development utility around the canonical contract package

Use another package when you want:

Install

python -m pip install ssot-codegen

For local development from this repository:

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

Command-line usage

The current command surface is intentionally small:

ssot-codegen --help
ssot-codegen --output-root .tmp_codegen

--output-root controls the directory where generated files are written. If omitted, the command writes to a .tmp_codegen directory under the current working directory.

Generated outputs

generate_python_artifacts() currently writes:

  • contracts.index.json
  • cli.metadata.json
  • tui.metadata.json
  • enums.py
  • cli_metadata.py
  • tui_metadata.py

Example:

ssot-codegen --output-root .tmp_codegen

Typical output files and purpose:

  • contracts.index.json: schema version and packaged ADR/spec manifest identifiers
  • cli.metadata.json: output formats and entity sections used by CLI-facing tooling
  • tui.metadata.json: entity sections used by TUI-facing tooling
  • enums.py: generated Python constants derived from CONTRACT_DATA

Programmatic usage

from ssot_codegen.generator import generate_python_artifacts

written = generate_python_artifacts(".tmp_codegen")
for path in written:
    print(path.as_posix())

Package relationships

  • Package type: development/code-generation package
  • Depends on: ssot-contracts, ssot-views
  • Consumed by: maintainers and release tooling that regenerate derived metadata artifacts

If you are using SSOT as an application or library, you usually do not need this package directly. It is primarily for maintainers working on the SSOT workspace itself.

Metadata

Release files for ssot-codegen 0.2.26

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

Source distribution (sdist)

Source distribution for ssot-codegen 0.2.26
File Size Uploaded Provenance
ssot_codegen-0.2.26.tar.gz 4.7 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for ssot-codegen 0.2.26
File Interpreter ABI Platform
ssot_codegen-0.2.26-py3-none-any.whl Python 3 none any Details

Total release size: 9.5 kB

Release files / ssot_codegen-0.2.26.tar.gz

Download URL ssot_codegen-0.2.26.tar.gz
Size 4.7 kB
Tags Source
SHA-256 checksum
How to use checksums
7afbfe0854fc921fe4d6bb780c0bafaae4efbfd7aa3618fd2730e8f107db221e
BLAKE2b-256 checksum
How to use checksums
3f6f5bd32ef06dab68a6d2c5b7618e9050bd536dd943919b8cbcc9f066370285
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","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 / ssot_codegen-0.2.26-py3-none-any.whl

Download URL ssot_codegen-0.2.26-py3-none-any.whl
Size 4.9 kB
Tags Python 3
SHA-256 checksum
How to use checksums
38caa12cd5f22848cd8ffe3968c45e53163c5e3b35324113d87e8feddcc8a515
BLAKE2b-256 checksum
How to use checksums
439b896d38ef3241d873fa9cbab48d36241e80b00314b57705fcebab7dc0b28c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.11.28 {"installer":{"name":"uv","version":"0.11.28","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 ssot-codegen 0.2.26

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.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

0.2.26 This release

2 release files No provenance

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