Skip to main content

Derived projections, reports, and graph exports for SSOT.

Project description

🔷 ssot-views

Derived reports and graph projections for SSOT registries.

PyPI version Supported Python versions Downloads Repository hits

ssot-views provides reusable derived projections for SSOT registries.

These outputs are non-canonical views built from registry data. The registry JSON remains the source of truth; this package focuses on reports and graph exports derived from that source.

What this package owns

  • validation and certification report builders
  • summary projections
  • graph export builders for JSON and DOT output

When to use this package

Use ssot-views when you want:

  • reusable Python functions for building SSOT reports
  • graph export payloads or DOT output outside the CLI
  • a small library dedicated to derived, read-oriented views

Use another package when you want:

  • ssot-registry for core runtime APIs and mutation/validation workflows
  • ssot-cli for command-line rendering and file output
  • ssot-contracts for packaged schemas and templates
  • ssot-tui for interactive terminal browsing
  • ssot-codegen for contract metadata regeneration

Install

python -m pip install ssot-views

For local development from this repository:

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

Public API

The top-level package currently exports:

  • build_validation_report
  • build_certification_report
  • build_summary
  • build_graph_json
  • build_graph_dot

Programmatic usage

Build a summary projection:

from ssot_views import build_summary

summary = build_summary(registry)
print(summary)

Build validation and certification reports:

from ssot_views import build_certification_report, build_validation_report

validation = build_validation_report(
    registry,
    ".ssot/registry.json",
    failures=[],
    warnings=[],
)

certification = build_certification_report(
    registry,
    ".ssot/registry.json",
    release_report={"passed": True, "boundary": {"id": "bnd:demo", "profile_ids": [], "feature_ids": []}},
)

Build graph exports:

from ssot_views import build_graph_dot, build_graph_json

graph_payload = build_graph_json(registry)
dot_text = build_graph_dot(registry)

Canonical vs derived outputs

  • Canonical: .ssot/registry.json
  • Derived: reports, summaries, graph exports, and similar projections

This distinction matters for workflow design: views are meant to be regenerated from canonical data, not edited as the source of truth.

Package relationships

  • Package type: derived-view library
  • Depends on: ssot-contracts
  • Consumed by: ssot-codegen, library users, and any tooling that needs reusable reports or graph exports

If you are building reporting, analysis, or export tooling around SSOT registries, this package is the appropriate reusable layer.

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

ssot_views-0.2.5.tar.gz (6.6 kB view details)

Uploaded Source

Built Distribution

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

ssot_views-0.2.5-py3-none-any.whl (6.4 kB view details)

Uploaded Python 3

File details

Details for the file ssot_views-0.2.5.tar.gz.

File metadata

  • Download URL: ssot_views-0.2.5.tar.gz
  • Upload date:
  • Size: 6.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","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 ssot_views-0.2.5.tar.gz
Algorithm Hash digest
SHA256 ead956167d9068996b13a79036dce63410730383b5ba2ffdcea48e5fb44948c8
MD5 bdc6d0735bf246f383777c495dd892e3
BLAKE2b-256 def3aabdc676cb84e2d6fdd86d1cbf0d293c12a93cd69cb0f2d587e7391e2495

See more details on using hashes here.

File details

Details for the file ssot_views-0.2.5-py3-none-any.whl.

File metadata

  • Download URL: ssot_views-0.2.5-py3-none-any.whl
  • Upload date:
  • Size: 6.4 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: uv/0.11.7 {"installer":{"name":"uv","version":"0.11.7","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 ssot_views-0.2.5-py3-none-any.whl
Algorithm Hash digest
SHA256 b85ba5836a54096a14daa1aca0e43617357bca2f912e2830629ab07c18488cf5
MD5 799b2f8784fdb8888eafa9ecdba8a0bc
BLAKE2b-256 c81ed7609ddd371e49359b2b086f409e1b8b36cc5c5e76084c26b76d2d9a8997

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