ssot-contracts 0.2.4__tar.gz

ssot_contracts-0.2.4/PKG-INFO

@@ -0,0 +1,34 @@
+Metadata-Version: 2.4
+Name: ssot-contracts
+Version: 0.2.4
+Summary: Canonical schemas, templates, manifests, and generated Python contract artifacts for SSOT.
+Author-email: Jacob Stewart <jacob@swarmauri.com>
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/groupsum/ssot-registry
+Project-URL: Repository, https://github.com/groupsum/ssot-registry
+Project-URL: Issues, https://github.com/groupsum/ssot-registry/issues
+Keywords: ssot,contracts,schemas,templates,manifests
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: File Formats :: JSON
+Classifier: Topic :: File Formats :: JSON :: JSON Schema
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: <3.14,>=3.10
+Description-Content-Type: text/markdown
+Requires-Dist: tomli>=2.0.1; python_version < "3.11"
+
+# ssot-contracts
+
+Canonical machine-readable SSOT artifacts:
+
+- JSON Schemas
+- packaged registry templates
+- packaged ssot-origin ADR and SPEC manifests
+- generated Python contract metadata

ssot_contracts-0.2.4/README.md

@@ -0,0 +1,8 @@
+# ssot-contracts
+
+Canonical machine-readable SSOT artifacts:
+
+- JSON Schemas
+- packaged registry templates
+- packaged ssot-origin ADR and SPEC manifests
+- generated Python contract metadata

ssot_contracts-0.2.4/pyproject.toml

@@ -0,0 +1,45 @@
+[build-system]
+requires = ["setuptools>=69", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "ssot-contracts"
+version = "0.2.4"
+description = "Canonical schemas, templates, manifests, and generated Python contract artifacts for SSOT."
+readme = "README.md"
+requires-python = ">=3.10,<3.14"
+license = "Apache-2.0"
+authors = [{ name = "Jacob Stewart", email = "jacob@swarmauri.com" }]
+dependencies = ["tomli>=2.0.1; python_version < '3.11'"]
+keywords = ["ssot", "contracts", "schemas", "templates", "manifests"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Intended Audience :: Developers",
+  "Operating System :: OS Independent",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3 :: Only",
+  "Programming Language :: Python :: 3.10",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Topic :: File Formats :: JSON",
+  "Topic :: File Formats :: JSON :: JSON Schema",
+  "Topic :: Software Development :: Libraries :: Python Modules",
+]
+
+[project.urls]
+Homepage = "https://github.com/groupsum/ssot-registry"
+Repository = "https://github.com/groupsum/ssot-registry"
+Issues = "https://github.com/groupsum/ssot-registry/issues"
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.package-data]
+"ssot_contracts.schema" = ["*.json"]
+"ssot_contracts.templates" = ["*.json"]
+"ssot_contracts.templates.adr" = ["*.md", "*.json"]
+"ssot_contracts.templates.specs" = ["*.md", "*.json"]

ssot_contracts-0.2.4/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

ssot_contracts-0.2.4/src/ssot_contracts/__init__.py

@@ -0,0 +1,20 @@
+from .contract_data import CONTRACT_DATA
+from .schema import list_schema_names, load_schema_text
+from .templates import (
+    list_document_manifest_entries,
+    load_document_manifest,
+    load_template_text,
+    read_packaged_document_bytes,
+    read_packaged_document_text,
+)
+
+__all__ = [
+    "CONTRACT_DATA",
+    "list_document_manifest_entries",
+    "list_schema_names",
+    "load_document_manifest",
+    "load_schema_text",
+    "load_template_text",
+    "read_packaged_document_bytes",
+    "read_packaged_document_text",
+]

ssot_contracts-0.2.4/src/ssot_contracts/contract_data.py

@@ -0,0 +1,92 @@
+from __future__ import annotations
+
+CONTRACT_DATA = {
+    "schema_version": 7,
+    "output_formats": ["json", "csv", "df", "yaml", "toml"],
+    "entity_sections": [
+        {"key": "features", "label": "Features"},
+        {"key": "profiles", "label": "Profiles"},
+        {"key": "tests", "label": "Tests"},
+        {"key": "claims", "label": "Claims"},
+        {"key": "evidence", "label": "Evidence"},
+        {"key": "issues", "label": "Issues"},
+        {"key": "risks", "label": "Risks"},
+        {"key": "boundaries", "label": "Boundaries"},
+        {"key": "releases", "label": "Releases"},
+        {"key": "adrs", "label": "ADRs"},
+        {"key": "specs", "label": "Specs"},
+    ],
+    "entity_prefixes": {
+        "repo": "repo:",
+        "features": "feat:",
+        "profiles": "prf:",
+        "tests": "tst:",
+        "claims": "clm:",
+        "evidence": "evd:",
+        "issues": "iss:",
+        "risks": "rsk:",
+        "boundaries": "bnd:",
+        "releases": "rel:",
+        "adrs": "adr:",
+        "specs": "spc:",
+    },
+    "graph_node_kind": {
+        "features": "feature",
+        "profiles": "profile",
+        "tests": "test",
+        "claims": "claim",
+        "evidence": "evidence",
+        "issues": "issue",
+        "risks": "risk",
+        "boundaries": "boundary",
+        "releases": "release",
+    },
+    "choice_sets": {
+        "feature_implementation_statuses": ["absent", "partial", "implemented"],
+        "feature_lifecycle_stages": ["active", "deprecated", "obsolete", "removed"],
+        "planning_horizons": ["current", "next", "future", "explicit", "backlog", "out_of_bounds"],
+        "test_statuses": ["planned", "passing", "failing", "blocked", "skipped"],
+        "profile_statuses": ["draft", "active", "retired"],
+        "profile_kinds": ["capability", "certification", "deployment", "interoperability"],
+        "claim_tiers": ["T0", "T1", "T2", "T3", "T4"],
+        "claim_statuses": [
+            "proposed",
+            "declared",
+            "implemented",
+            "asserted",
+            "evidenced",
+            "certified",
+            "promoted",
+            "published",
+            "blocked",
+            "retired",
+        ],
+        "evidence_statuses": ["planned", "collected", "passed", "failed", "stale"],
+        "issue_statuses": ["open", "in_progress", "blocked", "resolved", "closed"],
+        "risk_statuses": ["active", "mitigated", "accepted", "retired"],
+        "boundary_statuses": ["draft", "active", "frozen", "retired"],
+        "release_statuses": ["draft", "candidate", "certified", "promoted", "published", "revoked"],
+        "severities": ["low", "medium", "high", "critical"],
+        "document_statuses": ["draft", "in_review", "accepted", "rejected", "superseded", "withdrawn", "retired"],
+        "spec_kinds": ["normative", "operational", "governance", "local-policy"],
+    },
+    "document_contract": {
+        "kinds": ["adr", "spec"],
+        "sections": {"adr": "adrs", "spec": "specs"},
+        "filename_prefixes": {"adr": "ADR", "spec": "SPEC"},
+        "path_keys": {"adr": "adr_root", "spec": "spec_root"},
+        "reservation_keys": {"adr": "adr", "spec": "spec"},
+        "default_reservations": {
+            "adr": [
+                {"owner": "ssot-origin", "start": 1, "end": 499, "immutable": True, "deletable": False, "assignable_by_repo": False},
+                {"owner": "ssot-core", "start": 500, "end": 999, "immutable": True, "deletable": False, "assignable_by_repo": False},
+                {"owner": "repo-local-default", "start": 1000, "end": 4999, "immutable": False, "deletable": True, "assignable_by_repo": True},
+            ],
+            "spec": [
+                {"owner": "ssot-origin", "start": 1, "end": 499, "immutable": True, "deletable": False, "assignable_by_repo": False},
+                {"owner": "ssot-core", "start": 500, "end": 999, "immutable": True, "deletable": False, "assignable_by_repo": False},
+                {"owner": "repo-local-default", "start": 1000, "end": 4999, "immutable": False, "deletable": True, "assignable_by_repo": True},
+            ],
+        },
+    },
+}

ssot_contracts-0.2.4/src/ssot_contracts/generated/__init__.py

@@ -0,0 +1 @@
+__all__: list[str] = []

ssot_contracts-0.2.4/src/ssot_contracts/generated/python/__init__.py

@@ -0,0 +1,11 @@
+from .cli_metadata import CLI_COMMAND_LABELS, OUTPUT_FORMATS
+from .enums import *
+from .ids import *
+from .tui_metadata import ENTITY_SECTIONS, ENTITY_VIEW_SECTIONS
+
+__all__ = [
+    "CLI_COMMAND_LABELS",
+    "ENTITY_SECTIONS",
+    "ENTITY_VIEW_SECTIONS",
+    "OUTPUT_FORMATS",
+]

ssot_contracts-0.2.4/src/ssot_contracts/generated/python/cli_metadata.py

@@ -0,0 +1,6 @@
+from __future__ import annotations
+
+from ssot_contracts.contract_data import CONTRACT_DATA
+
+OUTPUT_FORMATS = tuple(CONTRACT_DATA["output_formats"])
+CLI_COMMAND_LABELS = tuple(section["key"] for section in CONTRACT_DATA["entity_sections"] if section["key"] not in {"adrs", "specs"})

ssot_contracts-0.2.4/src/ssot_contracts/generated/python/enums.py

@@ -0,0 +1,24 @@
+from __future__ import annotations
+
+from ssot_contracts.contract_data import CONTRACT_DATA
+
+SCHEMA_VERSION = CONTRACT_DATA["schema_version"]
+ENTITY_PREFIXES = CONTRACT_DATA["entity_prefixes"]
+GRAPH_NODE_KIND = CONTRACT_DATA["graph_node_kind"]
+
+FEATURE_IMPLEMENTATION_STATUSES = set(CONTRACT_DATA["choice_sets"]["feature_implementation_statuses"])
+FEATURE_LIFECYCLE_STAGES = set(CONTRACT_DATA["choice_sets"]["feature_lifecycle_stages"])
+PLANNING_HORIZONS = set(CONTRACT_DATA["choice_sets"]["planning_horizons"])
+TEST_STATUSES = set(CONTRACT_DATA["choice_sets"]["test_statuses"])
+PROFILE_STATUSES = set(CONTRACT_DATA["choice_sets"]["profile_statuses"])
+PROFILE_KINDS = set(CONTRACT_DATA["choice_sets"]["profile_kinds"])
+CLAIM_TIERS = set(CONTRACT_DATA["choice_sets"]["claim_tiers"])
+CLAIM_STATUSES = set(CONTRACT_DATA["choice_sets"]["claim_statuses"])
+EVIDENCE_STATUSES = set(CONTRACT_DATA["choice_sets"]["evidence_statuses"])
+ISSUE_STATUSES = set(CONTRACT_DATA["choice_sets"]["issue_statuses"])
+RISK_STATUSES = set(CONTRACT_DATA["choice_sets"]["risk_statuses"])
+BOUNDARY_STATUSES = set(CONTRACT_DATA["choice_sets"]["boundary_statuses"])
+RELEASE_STATUSES = set(CONTRACT_DATA["choice_sets"]["release_statuses"])
+SEVERITIES = set(CONTRACT_DATA["choice_sets"]["severities"])
+DOCUMENT_STATUSES = tuple(CONTRACT_DATA["choice_sets"]["document_statuses"])
+SPEC_KINDS = set(CONTRACT_DATA["choice_sets"]["spec_kinds"])

ssot_contracts-0.2.4/src/ssot_contracts/generated/python/ids.py

@@ -0,0 +1,8 @@
+from __future__ import annotations
+
+import re
+
+from ssot_contracts.contract_data import CONTRACT_DATA
+
+ENTITY_PREFIXES = CONTRACT_DATA["entity_prefixes"]
+ID_PATTERN = re.compile(r"^[a-z][a-z0-9-]*:[a-z0-9][a-z0-9._-]*$")

ssot_contracts-0.2.4/src/ssot_contracts/generated/python/tui_metadata.py

@@ -0,0 +1,18 @@
+from __future__ import annotations
+
+from ssot_contracts.contract_data import CONTRACT_DATA
+
+ENTITY_SECTIONS = tuple((section["key"], section["label"]) for section in CONTRACT_DATA["entity_sections"])
+ENTITY_VIEW_SECTIONS = {
+    "features": ("id", "title", "implementation_status"),
+    "profiles": ("id", "title", "status"),
+    "tests": ("id", "title", "status"),
+    "claims": ("id", "title", "status"),
+    "evidence": ("id", "title", "status"),
+    "issues": ("id", "title", "status"),
+    "risks": ("id", "title", "status"),
+    "boundaries": ("id", "title", "status"),
+    "releases": ("id", "version", "status"),
+    "adrs": ("id", "title", "status"),
+    "specs": ("id", "title", "status"),
+}

ssot_contracts-0.2.4/src/ssot_contracts/schema/__init__.py

@@ -0,0 +1,11 @@
+from __future__ import annotations
+
+from importlib import resources
+
+
+def list_schema_names() -> list[str]:
+    return sorted(entry.name for entry in resources.files(__package__).iterdir() if entry.name.endswith(".json"))
+
+
+def load_schema_text(name: str) -> str:
+    return resources.files(__package__).joinpath(name).read_text(encoding="utf-8")

ssot_contracts-0.2.4/src/ssot_contracts/schema/boundary.snapshot.schema.json

@@ -0,0 +1,15 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://example.invalid/ssot-registry/boundary.snapshot.schema.json",
+  "type": "object",
+  "required": [
+    "schema_version",
+    "kind",
+    "generated_at",
+    "registry_path",
+    "registry_sha256",
+    "boundary",
+    "features",
+    "summary"
+  ]
+}

ssot_contracts-0.2.4/src/ssot_contracts/schema/certification.report.schema.json

@@ -0,0 +1,11 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://example.invalid/ssot-registry/certification.report.schema.json",
+  "type": "object",
+  "required": [
+    "passed",
+    "registry_path",
+    "release",
+    "summary"
+  ]
+}

ssot_contracts-0.2.4/src/ssot_contracts/schema/graph.export.schema.json

@@ -0,0 +1,54 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://example.invalid/ssot-registry/graph.export.schema.json",
+  "type": "object",
+  "required": [
+    "nodes",
+    "edges"
+  ],
+  "properties": {
+    "nodes": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "id",
+          "kind"
+        ],
+        "properties": {
+          "id": {
+            "type": "string"
+          },
+          "kind": {
+            "type": "string"
+          }
+        },
+        "additionalProperties": false
+      }
+    },
+    "edges": {
+      "type": "array",
+      "items": {
+        "type": "object",
+        "required": [
+          "type",
+          "from",
+          "to"
+        ],
+        "properties": {
+          "type": {
+            "type": "string"
+          },
+          "from": {
+            "type": "string"
+          },
+          "to": {
+            "type": "string"
+          }
+        },
+        "additionalProperties": false
+      }
+    }
+  },
+  "additionalProperties": false
+}

ssot_contracts-0.2.4/src/ssot_contracts/schema/published.snapshot.schema.json

@@ -0,0 +1,17 @@
+{
+  "$schema": "https://json-schema.org/draft/2020-12/schema",
+  "$id": "https://example.invalid/ssot-registry/published.snapshot.schema.json",
+  "type": "object",
+  "required": [
+    "schema_version",
+    "kind",
+    "generated_at",
+    "registry_path",
+    "registry_sha256",
+    "release",
+    "boundary",
+    "claims",
+    "evidence",
+    "summary"
+  ]
+}