sort4circ-dpp 1.3.1__tar.gz

sort4circ_dpp-1.3.1/.dockerignore

@@ -0,0 +1,133 @@
+**
+!docker
+docker/**
+!spec
+spec/**
+!spec/governance
+spec/governance/**
+!spec/mappings
+spec/mappings/**
+!spec/ontology
+spec/ontology/**
+!spec/openapi
+spec/openapi/**
+!spec/queries
+spec/queries/**
+!spec/schemas
+spec/schemas/**
+!spec/vocabularies
+spec/vocabularies/**
+!src
+src/**
+!src/sort4circ_dpp
+src/sort4circ_dpp/**
+!src/sort4circ_dpp/_spec
+src/sort4circ_dpp/_spec/**
+!src/sort4circ_dpp/_spec/schemas
+src/sort4circ_dpp/_spec/schemas/**
+!src/sort4circ_dpp/_spec/vocabularies
+src/sort4circ_dpp/_spec/vocabularies/**
+!src/sort4circ_dpp/gateway
+src/sort4circ_dpp/gateway/**
+!src/sort4circ_dpp/ledger
+src/sort4circ_dpp/ledger/**
+!tools
+tools/**
+!.dockerignore
+!LICENSE
+!LICENSE-DOCS
+!LICENSING.md
+!MANIFEST.in
+!README.md
+!docker/Dockerfile
+!docker/compose.example.yml
+!public-release-policy.json
+!pyproject.toml
+!setup.py
+!spec/access-matrix.json
+!spec/governance/en18223-deviation-open-template.json
+!spec/governance/en18223-deviation.schema.json
+!spec/governance/environmental-selection-template.json
+!spec/governance/environmental-selection.schema.json
+!spec/mappings/README.md
+!spec/mappings/dpp-mapping-1.0.0.csv
+!spec/mappings/dpp-mapping-1.0.0.json
+!spec/mappings/dpp-mapping-1.0.0.schema.json
+!spec/ontology/sort4circ-1.0.1.ttl
+!spec/openapi/dpp-api-v1.json
+!spec/queries/environmental-values-1.0.0.rq
+!spec/queries/expected-results-1.0.0.json
+!spec/queries/identity-resolution-1.0.0.rq
+!spec/queries/lifecycle-events-1.0.0.rq
+!spec/queries/material-divergence-1.0.0.rq
+!spec/queries/product-hierarchy-1.0.0.rq
+!spec/queries/sorting-results-1.0.0.rq
+!spec/reason-codes.json
+!spec/schemas/dpp-1.0.0.schema.json
+!spec/schemas/dpp-1.0.0.xsd
+!spec/vocabularies/article-class.json
+!spec/vocabularies/binding-status.json
+!spec/vocabularies/carrier-type.json
+!spec/vocabularies/colour-family.json
+!spec/vocabularies/component-type.json
+!spec/vocabularies/condition.json
+!spec/vocabularies/confidence-scale.json
+!spec/vocabularies/encoding-scheme.json
+!spec/vocabularies/event-type.json
+!spec/vocabularies/evidence-state.json
+!spec/vocabularies/fabric-construction.json
+!spec/vocabularies/fibre-type.json
+!spec/vocabularies/method.json
+!spec/vocabularies/passport-status.json
+!spec/vocabularies/percentage-basis.json
+!spec/vocabularies/sorting-category.json
+!spec/vocabularies/technical-flag.json
+!spec/vocabularies/value-status.json
+!src/sort4circ_dpp/__init__.py
+!src/sort4circ_dpp/_spec/access-matrix.json
+!src/sort4circ_dpp/_spec/reason-codes.json
+!src/sort4circ_dpp/_spec/schemas/dpp-1.0.0.schema.json
+!src/sort4circ_dpp/_spec/schemas/dpp-1.0.0.xsd
+!src/sort4circ_dpp/_spec/vocabularies/article-class.json
+!src/sort4circ_dpp/_spec/vocabularies/binding-status.json
+!src/sort4circ_dpp/_spec/vocabularies/carrier-type.json
+!src/sort4circ_dpp/_spec/vocabularies/colour-family.json
+!src/sort4circ_dpp/_spec/vocabularies/component-type.json
+!src/sort4circ_dpp/_spec/vocabularies/condition.json
+!src/sort4circ_dpp/_spec/vocabularies/confidence-scale.json
+!src/sort4circ_dpp/_spec/vocabularies/encoding-scheme.json
+!src/sort4circ_dpp/_spec/vocabularies/event-type.json
+!src/sort4circ_dpp/_spec/vocabularies/evidence-state.json
+!src/sort4circ_dpp/_spec/vocabularies/fabric-construction.json
+!src/sort4circ_dpp/_spec/vocabularies/fibre-type.json
+!src/sort4circ_dpp/_spec/vocabularies/method.json
+!src/sort4circ_dpp/_spec/vocabularies/passport-status.json
+!src/sort4circ_dpp/_spec/vocabularies/percentage-basis.json
+!src/sort4circ_dpp/_spec/vocabularies/sorting-category.json
+!src/sort4circ_dpp/_spec/vocabularies/technical-flag.json
+!src/sort4circ_dpp/_spec/vocabularies/value-status.json
+!src/sort4circ_dpp/access.py
+!src/sort4circ_dpp/api.py
+!src/sort4circ_dpp/auth.py
+!src/sort4circ_dpp/canonical.py
+!src/sort4circ_dpp/cli.py
+!src/sort4circ_dpp/config.py
+!src/sort4circ_dpp/evidence.py
+!src/sort4circ_dpp/exchange.py
+!src/sort4circ_dpp/gateway/__init__.py
+!src/sort4circ_dpp/gateway/readzone.py
+!src/sort4circ_dpp/governance.py
+!src/sort4circ_dpp/index.py
+!src/sort4circ_dpp/ledger/__init__.py
+!src/sort4circ_dpp/ledger/base.py
+!src/sort4circ_dpp/ledger/besu.py
+!src/sort4circ_dpp/ledger/memory.py
+!src/sort4circ_dpp/mapping.py
+!src/sort4circ_dpp/public_summary.py
+!src/sort4circ_dpp/py.typed
+!src/sort4circ_dpp/reasons.py
+!src/sort4circ_dpp/store.py
+!src/sort4circ_dpp/synthetic.py
+!src/sort4circ_dpp/validation.py
+!src/sort4circ_dpp/vocab.py
+!tools/verify_public_release.py

sort4circ_dpp-1.3.1/.editorconfig

@@ -0,0 +1,17 @@
+root = true
+
+[*]
+charset = utf-8
+end_of_line = lf
+insert_final_newline = true
+trim_trailing_whitespace = true
+indent_style = space
+
+[*.py]
+indent_size = 4
+
+[*.{json,yml,yaml,md,ttl}]
+indent_size = 2
+
+[Makefile]
+indent_style = tab

sort4circ_dpp-1.3.1/.gitattributes

@@ -0,0 +1 @@
+* text=auto eol=lf

sort4circ_dpp-1.3.1/.github/CODEOWNERS

@@ -0,0 +1,20 @@
+# Review ownership for this repository.
+#
+# GitHub requests a review from the owning team on any pull request touching a
+# matching path. These entries only gate a merge once branch protection on the
+# default branch requires review from code owners, which is a repository setting
+# and not something this file can enable.
+#
+# The team must exist in the Constructor-Uni organisation and hold write access on
+# this repository. GitHub ignores an entry naming a team that does not exist, or
+# that lacks write access, without reporting an error.
+
+* @Constructor-Uni/sort4circ-wp4
+
+# Specification assets, the publication allowlist, the licence coverage map, and the
+# workflows that build and publish releases. Later rules win in CODEOWNERS, so these
+# are listed after the global rule to keep them authoritative for their paths.
+spec/**                     @Constructor-Uni/sort4circ-wp4
+public-release-policy.json  @Constructor-Uni/sort4circ-wp4
+LICENSING.md                @Constructor-Uni/sort4circ-wp4
+.github/workflows/**        @Constructor-Uni/sort4circ-wp4

sort4circ_dpp-1.3.1/.github/ISSUE_TEMPLATE/bug_report.yml

@@ -0,0 +1,65 @@
+name: Non-sensitive bug report
+description: Report a non-sensitive bug in the public DPP reference implementation.
+labels:
+- bug
+body:
+- type: markdown
+  attributes:
+    value: 'Public GitHub issues are only for non-sensitive bugs and feature requests.
+
+      Do not post security vulnerabilities or suspected accidental project-data exposure here.
+
+      Use GitHub Private Vulnerability Reporting and follow SECURITY.md. If that option is
+
+      unavailable, keep the report private; do not use a public issue as a fallback.
+
+
+      Use independently synthetic reproductions only, including in private reports.
+
+      Do not submit real credentials, private configuration, partner data, project data,
+
+      pilot data or internal endpoints in payloads, attachments, screenshots, logs or comments.
+
+      Describe suspected exposure privately without reproducing the exposed material.
+
+
+      Synthetic example. Not SORT4CIRC project data.'
+- type: textarea
+  id: expected
+  attributes:
+    label: What the specification requires
+    description: Name a public specification artefact, field, API route or reason code.
+  validations:
+    required: true
+- type: textarea
+  id: actual
+  attributes:
+    label: What happens instead
+  validations:
+    required: true
+- type: textarea
+  id: reproduce
+  attributes:
+    label: Smallest synthetic reproduction
+    description: Use fictional inputs only; never attach operational logs or private data.
+    render: shell
+  validations:
+    required: true
+- type: input
+  id: version
+  attributes:
+    label: Public release version
+    description: Name a public release version; do not include private references or endpoints.
+  validations:
+    required: true
+- type: checkboxes
+  id: public_synthetic_confirmation
+  attributes:
+    label: Public issue confirmation
+    options:
+    - label: This is a non-sensitive bug or feature request, not a security or suspected data-exposure
+        report.
+      required: true
+    - label: All reproduction material is synthetic and excludes real credentials, private configuration,
+        partner/project/pilot data and internal endpoints.
+      required: true

sort4circ_dpp-1.3.1/.github/ISSUE_TEMPLATE/spec_question.yml

@@ -0,0 +1,69 @@
+name: Specification bug or feature request
+description: Report a non-sensitive public-profile defect or propose a feature.
+labels:
+- specification
+body:
+- type: markdown
+  attributes:
+    value: 'Public GitHub issues are only for non-sensitive bugs and feature requests.
+
+      Do not post security vulnerabilities or suspected accidental project-data exposure here.
+
+      Use GitHub Private Vulnerability Reporting and follow SECURITY.md. If that option is
+
+      unavailable, keep the report private; do not use a public issue as a fallback.
+
+
+      Use independently synthetic reproductions only, including in private reports.
+
+      Do not submit real credentials, private configuration, partner data, project data,
+
+      pilot data or internal endpoints in payloads, attachments, screenshots, logs or comments.
+
+      Describe suspected exposure privately without reproducing the exposed material.
+
+
+      Synthetic example. Not SORT4CIRC project data.'
+- type: dropdown
+  id: kind
+  attributes:
+    label: Kind
+    options:
+    - 'Bug: the documentation or rule is unclear'
+    - 'Bug: a public-profile rule cannot be implemented as written'
+    - 'Bug: an implemented rule has incorrect behaviour'
+    - 'Feature: a public-profile capability is missing'
+    - 'Feature: a new controlled value is needed'
+  validations:
+    required: true
+- type: textarea
+  id: artefact
+  attributes:
+    label: Which artefact and clause
+  validations:
+    required: true
+- type: textarea
+  id: consequence
+  attributes:
+    label: What breaks if it stays as it is
+    description: Give a concrete case with independently synthetic data only.
+  validations:
+    required: true
+- type: textarea
+  id: migration
+  attributes:
+    label: What happens to records already written under the current rule
+    description: Describe migration with fictional records only; do not provide real datasets.
+  validations:
+    required: true
+- type: checkboxes
+  id: public_synthetic_confirmation
+  attributes:
+    label: Public issue confirmation
+    options:
+    - label: This is a non-sensitive bug or feature request, not a security or suspected data-exposure
+        report.
+      required: true
+    - label: All reproduction material is synthetic and excludes real credentials, private configuration,
+        partner/project/pilot data and internal endpoints.
+      required: true

sort4circ_dpp-1.3.1/.github/PULL_REQUEST_TEMPLATE.md

@@ -0,0 +1,23 @@
+## Public contribution only
+
+Use this template only for non-sensitive changes. Security vulnerabilities and suspected accidental project-data exposure must not be posted in public issues or pull requests. Use GitHub Private Vulnerability Reporting and follow SECURITY.md.
+
+All reproductions must be independently synthetic, including private reports. Do not submit real credentials, private configuration, partner data, project data, pilot data or internal endpoints in changes, attachments, screenshots, logs or comments. Describe suspected exposure privately without reproducing the exposed material.
+
+## Public-profile change
+
+Describe the problem, resulting behaviour and any version/migration impact using synthetic examples only.
+
+## Validation
+
+List the tests actually run. Confirm fixture, mapping/OpenAPI and release-policy checks where relevant. Do not attach raw operational output.
+
+## Publication boundary
+
+- [ ] This pull request contains no security vulnerability report or suspected project-data exposure report.
+- [ ] Reproductions and examples are independently synthetic.
+- [ ] No real credentials, private configuration, partner data, project data, pilot data or internal endpoints are included.
+- [ ] No personal data, private reviews, raw operational logs or historical evidence are attached.
+- [ ] New public files were deliberately reviewed for the explicit allowlist.
+- [ ] Claims describe public-profile conformance only.
+- [ ] The component licences (Apache-2.0 software, CC BY 4.0 docs/spec) and third-party notices are respected; new public files have explicit coverage under LICENSING.md.

sort4circ_dpp-1.3.1/.github/dependabot.yml

@@ -0,0 +1,27 @@
+version: 2
+
+updates:
+  # Runtime and development Python dependencies. Version bumps must keep the pinned
+  # constraints file in step: see constraints-py311-py312-py313.txt.
+  - package-ecosystem: pip
+    directory: /
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 5
+    labels:
+      - dependencies
+    commit-message:
+      prefix: "deps"
+
+  # Workflow actions are pinned to commit SHAs. Dependabot updates the SHA and the
+  # trailing version comment together, which keeps the pinning intact.
+  - package-ecosystem: github-actions
+    directory: /
+    schedule:
+      interval: weekly
+    open-pull-requests-limit: 5
+    labels:
+      - dependencies
+      - ci
+    commit-message:
+      prefix: "ci"

sort4circ_dpp-1.3.1/.github/workflows/ci.yml

@@ -0,0 +1,255 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  test:
+    name: Test on Python ${{ matrix.python-version }}
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
+
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: ${{ matrix.python-version }}
+          cache: pip
+
+      - name: Install
+        run: python -m pip install -c constraints-py311-py312-py313.txt -e ".[dev]"
+
+      - name: Lint
+        run: ruff check src tests tools examples
+
+      - name: Test
+        run: python -m pytest -q
+
+      - name: Validate fixtures
+        run: python tools/validate_fixtures.py
+
+      - name: Worked example
+        run: python examples/worked_example.py
+
+      - name: Mapping CSV is up to date
+        run: python tools/gen_mapping_csv.py --check
+
+      - name: Public file policy
+        run: python tools/verify_public_release.py --files-only
+
+      - name: Public manifest
+        run: python verify_files.py
+
+  spec:
+    name: Specification artefacts
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
+
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: "3.12"
+          cache: pip
+
+      - name: Install
+        run: pip install -c constraints-py311-py312-py313.txt -e ".[dev]"
+
+      - name: Ontology parses without error
+        run: |
+          python - <<'PY'
+          from rdflib import Graph
+          g = Graph().parse("spec/ontology/sort4circ-1.0.1.ttl", format="turtle")
+          print(f"{len(g)} triples")
+          assert len(g) > 200, "the ontology lost content"
+          PY
+
+      - name: Every JSON artefact parses
+        run: |
+          python - <<'PY'
+          import json, pathlib
+          for path in sorted(pathlib.Path("spec").rglob("*.json")):
+              json.loads(path.read_text(encoding="utf-8"))
+              print("ok", path)
+          PY
+
+      - name: The OpenAPI contract is up to date
+        run: |
+          python tools/gen_openapi.py
+          git diff --exit-code spec/openapi/ || {
+            echo "::error::spec/openapi is stale. Run 'make openapi' and commit the result."
+            exit 1
+          }
+
+  conformance:
+    name: Conformance report
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: "3.12"
+          cache: pip
+      - run: pip install -c constraints-py311-py312-py313.txt -e ".[dev]"
+      - run: python tools/conformance_report.py --output conformance-report.json
+      - uses: actions/upload-artifact@ea165f8d65b6e75b540449e92b4886f43607fa02 # v4.6.2
+        with:
+          name: conformance-report
+          path: conformance-report.json
+          if-no-files-found: error
+
+  wheel-smoke:
+    name: Installed wheel smoke
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
+
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: "3.12"
+          cache: pip
+
+      - name: Build wheel outside the checkout
+        run: |
+          set -euo pipefail
+          mkdir -p "$RUNNER_TEMP/s4c-wheel"
+          mkdir -p "$RUNNER_TEMP/s4c-wheel-smoke"
+          python -m pip wheel . --no-deps --wheel-dir "$RUNNER_TEMP/s4c-wheel"
+
+      - name: Inspect packaged runtime resources
+        run: |
+          python - <<'PY'
+          import os
+          import pathlib
+          import zipfile
+
+          root = pathlib.Path.cwd()
+          wheel = next((pathlib.Path(os.environ["RUNNER_TEMP"]) / "s4c-wheel").glob("*.whl"))
+          expected = {
+              "access-matrix.json",
+              "reason-codes.json",
+              "schemas/dpp-1.0.0.schema.json",
+              "schemas/dpp-1.0.0.xsd",
+              *(path.relative_to(root / "spec").as_posix()
+                for path in (root / "spec" / "vocabularies").glob("*.json")),
+          }
+          with zipfile.ZipFile(wheel) as archive:
+              prefix = "sort4circ_dpp/_spec/"
+              actual = {
+                  name.removeprefix(prefix)
+                  for name in archive.namelist()
+                  if name.startswith(prefix) and not name.endswith("/")
+              }
+          assert actual == expected, (sorted(actual), sorted(expected))
+          print(f"verified {len(actual)} runtime resources")
+          PY
+
+      - name: Install wheel in a clean environment
+        run: |
+          set -euo pipefail
+          python -m venv "$RUNNER_TEMP/s4c-wheel-venv"
+          "$RUNNER_TEMP/s4c-wheel-venv/bin/python" -m pip install \
+            -c "$GITHUB_WORKSPACE/constraints-py311-py312-py313.txt" \
+            "$(find "$RUNNER_TEMP/s4c-wheel" -name '*.whl' -print -quit)"
+
+      - name: Exercise installed wheel outside the checkout
+        env:
+          WHEEL_VENV: ${{ runner.temp }}/s4c-wheel-venv
+        working-directory: ${{ runner.temp }}/s4c-wheel-smoke
+        run: |
+          set -euo pipefail
+          test ! -e spec
+          "$WHEEL_VENV/bin/python" - <<'PY'
+          import asyncio
+          import os
+          import pathlib
+          import sys
+
+          import sort4circ_dpp
+          from fastapi import FastAPI
+          from sort4circ_dpp.api import create_app
+          from sort4circ_dpp.reasons import released_codes
+          from sort4circ_dpp.validation import schema, validate_schema
+          from sort4circ_dpp.vocab import load
+
+          origin = pathlib.Path(sort4circ_dpp.__file__).resolve()
+          prefix = pathlib.Path(sys.prefix).resolve()
+          assert origin.is_relative_to(prefix), (origin, prefix)
+          assert released_codes()
+          assert load("article-class").tokens
+          assert schema()["$schema"]
+          try:
+              validate_schema({})
+          except Exception:
+              pass
+          else:
+              raise AssertionError("an empty payload unexpectedly passed schema validation")
+
+          app = create_app()
+          assert isinstance(app, FastAPI)
+          messages = []
+
+          async def receive():
+              return {"type": "http.request", "body": b"", "more_body": False}
+
+          async def send(message):
+              messages.append(message)
+
+          scope = {
+              "type": "http",
+              "asgi": {"version": "3.0", "spec_version": "2.0"},
+              "method": "GET",
+              "path": "/health",
+              "raw_path": b"/health",
+              "query_string": b"",
+              "headers": [],
+              "http_version": "1.1",
+              "client": ("127.0.0.1", 1),
+              "server": ("test", 80),
+              "scheme": "http",
+              "root_path": "",
+          }
+
+          asyncio.run(app(scope, receive, send))
+          response = next(message for message in messages if message["type"] == "http.response.start")
+          assert response["status"] == 200
+          print("installed wheel smoke passed")
+          PY
+
+      - name: Clean temporary wheel resources
+        if: always()
+        run: |
+          rm -rf "$RUNNER_TEMP/s4c-wheel" \
+                 "$RUNNER_TEMP/s4c-wheel-venv" \
+                 "$RUNNER_TEMP/s4c-wheel-smoke"
+
+  package:
+    name: Public export and distributions
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4.4.0
+      - uses: actions/setup-python@a26af69be951a213d495a4c3e4e4022e16d87065 # v5.6.0
+        with:
+          python-version: "3.12"
+          cache: pip
+      - run: python -m pip install -c constraints-py311-py312-py313.txt build
+      - name: Export only the allowlisted public files
+        run: python tools/verify_public_release.py --files-only --export ../public-profile-export
+      - name: Build the distributions from the export
+        run: python -m build ../public-profile-export --outdir ../public-profile-dist
+      - name: Verify the built distributions against the file policy
+        run: |
+          python - <<'PY'
+          from pathlib import Path
+          from tools.verify_public_release import verify_archive
+          for path in sorted(Path("../public-profile-dist").iterdir()):
+              print(path.name, verify_archive(path), "files verified")
+          PY