sdcgovernance 4.0.0__tar.gz

sdcgovernance-4.0.0/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

sdcgovernance-4.0.0/PKG-INFO

@@ -0,0 +1,171 @@
+Metadata-Version: 2.4
+Name: sdcgovernance
+Version: 4.0.0
+Summary: W3C standards-based governance validation for Semantic Data Charter instances
+Author: Semantic Data Charter Foundation
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://semanticdatacharter.com
+Project-URL: Repository, https://github.com/SemanticDataCharter/sdcgovernance
+Project-URL: Issues, https://github.com/SemanticDataCharter/sdcgovernance/issues
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Libraries
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: lxml>=5.0
+Requires-Dist: rdflib>=7.0
+Requires-Dist: pyshacl>=0.25
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Dynamic: license-file
+
+# sdcgovernance
+
+W3C standards-based governance advisory engine for Semantic Data Charter instances.
+
+A Python library that validates governance content in XML data instances against governance components defined in the SDC data model. If the model defines governance (workflow, attestation, party/role, provenance, audit), the instance must carry that content - and this library validates it.
+
+Returns decisions using OASIS XACML semantics: PERMIT, DENY, or INDETERMINATE.
+
+No framework dependency. No middleware. A function call.
+
+## How It Works
+
+SDC data models (XSD) can optionally include governance components: Workflow state machines, Attestation authority requirements, Party/Role constraints, Provenance requirements, and Audit definitions. These are part of the data model, not a separate governance layer.
+
+When governance components are defined, every XML data instance must carry the corresponding governance content. This library validates that content against the model:
+
+```python
+from sdcgovernance import validate_governance
+
+result = validate_governance("model.xsd", "instance.xml")
+
+print(result.decision)      # PERMIT, DENY, or INDETERMINATE
+print(result.has_governance) # True if model defines governance components
+print(result.errors)         # list of governance validation errors
+print(result.receipt)        # tamper-evident decision receipt
+```
+
+If the model does not define governance components, the result is `PERMIT` - no governance to enforce.
+
+## Two Independent Libraries
+
+sdcvalidator and sdcgovernance are separate, independent libraries. There is no hook, no chaining, no automatic invocation of one from the other.
+
+```
+sdcvalidator (structural validation)
+    Does the instance conform to the XSD schema?
+    Single-pass. Instance in, pass/fail out.
+
+sdcgovernance (governance advisory)
+    Does the model define governance components?
+    If yes: does the instance carry valid governance content?
+    Conversational. Agents query multiple times during a workflow.
+```
+
+Both libraries read the schema from the instance. Agents call each one independently, at different points in a workflow, in whatever order the operational logic requires. A single workflow may involve multiple calls to both libraries.
+
+## What Gets Validated
+
+| Component | What the model defines | What the instance must carry |
+|---|---|---|
+| **Workflow** | Cluster tree of valid paths (sub-clusters with XdOrdinal states) | Current XdOrdinal state, proposed transition validated against ordinal adjacency in valid paths |
+| **Attestation** | Authority requirements per action | Attestation with correct role, party reference, timestamp |
+| **Party/Role** | Role constraints for governed actions | Acting party identification with required role |
+| **Provenance/Audit** | Provenance requirements (PROV-O) + retention policy (DPV) | PROV-formatted record(s) per retention policy: most recent + hash, last N, or full chain |
+
+Governance components are discovered by **vocabulary binding**, not by CUID2 identity. Any component bound to the right standard vocabulary (PROV-O, SCXML, VC, DPV) is recognized as a governance component - whether it comes from the Default project or was custom-built.
+
+## Enforcement Decisions (OASIS XACML)
+
+| Decision | Meaning |
+|---|---|
+| **PERMIT** | All governance checks pass - action is authorized |
+| **DENY** | One or more governance checks fail - action is refused |
+| **INDETERMINATE** | Governance checks partially pass - requires review (configurable) |
+
+Every decision produces a W3C PROV record and a SHA-256 hash-chained receipt.
+
+What happens after the decision is the agent's responsibility. sdcgovernance issues the decision and the receipt. The operational response - routing, escalation, notification, halting - is customer business logic that varies per implementation.
+
+## Two Interfaces, One Engine
+
+**Python API** - for direct integration:
+
+```python
+from sdcgovernance import validate_governance
+
+result = validate_governance("model.xsd", "instance.xml")
+```
+
+**MCP Server** - for any agent framework:
+
+```bash
+sdcgovernance serve --mcp
+```
+
+The MCP server exposes governance as tools that agents call. The agent runs the loop. sdcgovernance advises.
+
+## Standards
+
+- **OASIS XACML** - decision semantics (PERMIT/DENY/INDETERMINATE)
+- **SDC native structure + W3C SCXML concepts** - workflow sequencing via XdOrdinal components in sub-cluster paths, borrowing the concepts of state and transition from automata theory as specified in W3C SCXML
+- **W3C PROV** (PROV-O, PROV-DM) - provenance/audit records (one governance dimension)
+- **W3C Data Privacy Vocabulary (DPV)** - provenance retention policy (same vocabulary used for SDC access control)
+- **W3C Activity Streams 2.0** - activity/event type vocabulary
+- **W3C Verifiable Credentials Data Model 2.0** - attestation authority pattern
+- **W3C SHACL** - cross-entity constraint validation
+- **OMG DMN** - decision tables for complex governance rules
+- **SHA-256** - tamper-evident hash chains for decision receipts
+
+## Architecture
+
+```
+src/sdcgovernance/
+├── __init__.py          # Public API: validate_governance()
+├── engine.py            # GovernanceEngine - the decision engine agents query
+├── model_inspector.py   # Inspect SDC model for governance components
+├── workflow.py          # Validate workflow transitions in instance
+├── attestation.py       # Validate attestation content in instance
+├── party_role.py        # Validate party/role constraints in instance
+├── provenance.py        # Validate provenance/audit records + PROV generation + DPV retention policy
+├── decision.py          # DMN decision table evaluation
+├── receipts.py          # Decision receipt chain (hash-chained)
+├── shacl_runtime.py     # SHACL cross-entity constraint validation
+└── mcp_server.py        # MCP server exposing governance tools to any agent
+```
+
+Pure Python. No Django. No middleware. No web framework dependency.
+
+## Installation
+
+```bash
+pip install sdcgovernance
+```
+
+## Integration with SDC Ecosystem
+
+- **sdcvalidator** - independent structural validation library. Agents call it separately from sdcgovernance, at different points in a workflow.
+- **SDCStudio** - models governance components visually. The XSD output includes governance definitions that sdcgovernance validates against.
+- **AppGen** - generated applications can call `validate_governance()` at data entry boundaries.
+- **SDC Agents** - reference implementations showing how to wire governance MCP tools into agentic workflows using Default project governance models. Customer agents connect to the same MCP server and use the tools however they want.
+
+## Status
+
+Pre-alpha. Planning phase. See [PLANNING.md](PLANNING.md) for the architecture and implementation roadmap.
+
+## Dependencies
+
+- `rdflib` - RDF/PROV record generation
+- `pyshacl` - SHACL constraint validation
+
+## License
+
+Apache 2.0

sdcgovernance-4.0.0/README.md

@@ -0,0 +1,143 @@
+# sdcgovernance
+
+W3C standards-based governance advisory engine for Semantic Data Charter instances.
+
+A Python library that validates governance content in XML data instances against governance components defined in the SDC data model. If the model defines governance (workflow, attestation, party/role, provenance, audit), the instance must carry that content - and this library validates it.
+
+Returns decisions using OASIS XACML semantics: PERMIT, DENY, or INDETERMINATE.
+
+No framework dependency. No middleware. A function call.
+
+## How It Works
+
+SDC data models (XSD) can optionally include governance components: Workflow state machines, Attestation authority requirements, Party/Role constraints, Provenance requirements, and Audit definitions. These are part of the data model, not a separate governance layer.
+
+When governance components are defined, every XML data instance must carry the corresponding governance content. This library validates that content against the model:
+
+```python
+from sdcgovernance import validate_governance
+
+result = validate_governance("model.xsd", "instance.xml")
+
+print(result.decision)      # PERMIT, DENY, or INDETERMINATE
+print(result.has_governance) # True if model defines governance components
+print(result.errors)         # list of governance validation errors
+print(result.receipt)        # tamper-evident decision receipt
+```
+
+If the model does not define governance components, the result is `PERMIT` - no governance to enforce.
+
+## Two Independent Libraries
+
+sdcvalidator and sdcgovernance are separate, independent libraries. There is no hook, no chaining, no automatic invocation of one from the other.
+
+```
+sdcvalidator (structural validation)
+    Does the instance conform to the XSD schema?
+    Single-pass. Instance in, pass/fail out.
+
+sdcgovernance (governance advisory)
+    Does the model define governance components?
+    If yes: does the instance carry valid governance content?
+    Conversational. Agents query multiple times during a workflow.
+```
+
+Both libraries read the schema from the instance. Agents call each one independently, at different points in a workflow, in whatever order the operational logic requires. A single workflow may involve multiple calls to both libraries.
+
+## What Gets Validated
+
+| Component | What the model defines | What the instance must carry |
+|---|---|---|
+| **Workflow** | Cluster tree of valid paths (sub-clusters with XdOrdinal states) | Current XdOrdinal state, proposed transition validated against ordinal adjacency in valid paths |
+| **Attestation** | Authority requirements per action | Attestation with correct role, party reference, timestamp |
+| **Party/Role** | Role constraints for governed actions | Acting party identification with required role |
+| **Provenance/Audit** | Provenance requirements (PROV-O) + retention policy (DPV) | PROV-formatted record(s) per retention policy: most recent + hash, last N, or full chain |
+
+Governance components are discovered by **vocabulary binding**, not by CUID2 identity. Any component bound to the right standard vocabulary (PROV-O, SCXML, VC, DPV) is recognized as a governance component - whether it comes from the Default project or was custom-built.
+
+## Enforcement Decisions (OASIS XACML)
+
+| Decision | Meaning |
+|---|---|
+| **PERMIT** | All governance checks pass - action is authorized |
+| **DENY** | One or more governance checks fail - action is refused |
+| **INDETERMINATE** | Governance checks partially pass - requires review (configurable) |
+
+Every decision produces a W3C PROV record and a SHA-256 hash-chained receipt.
+
+What happens after the decision is the agent's responsibility. sdcgovernance issues the decision and the receipt. The operational response - routing, escalation, notification, halting - is customer business logic that varies per implementation.
+
+## Two Interfaces, One Engine
+
+**Python API** - for direct integration:
+
+```python
+from sdcgovernance import validate_governance
+
+result = validate_governance("model.xsd", "instance.xml")
+```
+
+**MCP Server** - for any agent framework:
+
+```bash
+sdcgovernance serve --mcp
+```
+
+The MCP server exposes governance as tools that agents call. The agent runs the loop. sdcgovernance advises.
+
+## Standards
+
+- **OASIS XACML** - decision semantics (PERMIT/DENY/INDETERMINATE)
+- **SDC native structure + W3C SCXML concepts** - workflow sequencing via XdOrdinal components in sub-cluster paths, borrowing the concepts of state and transition from automata theory as specified in W3C SCXML
+- **W3C PROV** (PROV-O, PROV-DM) - provenance/audit records (one governance dimension)
+- **W3C Data Privacy Vocabulary (DPV)** - provenance retention policy (same vocabulary used for SDC access control)
+- **W3C Activity Streams 2.0** - activity/event type vocabulary
+- **W3C Verifiable Credentials Data Model 2.0** - attestation authority pattern
+- **W3C SHACL** - cross-entity constraint validation
+- **OMG DMN** - decision tables for complex governance rules
+- **SHA-256** - tamper-evident hash chains for decision receipts
+
+## Architecture
+
+```
+src/sdcgovernance/
+├── __init__.py          # Public API: validate_governance()
+├── engine.py            # GovernanceEngine - the decision engine agents query
+├── model_inspector.py   # Inspect SDC model for governance components
+├── workflow.py          # Validate workflow transitions in instance
+├── attestation.py       # Validate attestation content in instance
+├── party_role.py        # Validate party/role constraints in instance
+├── provenance.py        # Validate provenance/audit records + PROV generation + DPV retention policy
+├── decision.py          # DMN decision table evaluation
+├── receipts.py          # Decision receipt chain (hash-chained)
+├── shacl_runtime.py     # SHACL cross-entity constraint validation
+└── mcp_server.py        # MCP server exposing governance tools to any agent
+```
+
+Pure Python. No Django. No middleware. No web framework dependency.
+
+## Installation
+
+```bash
+pip install sdcgovernance
+```
+
+## Integration with SDC Ecosystem
+
+- **sdcvalidator** - independent structural validation library. Agents call it separately from sdcgovernance, at different points in a workflow.
+- **SDCStudio** - models governance components visually. The XSD output includes governance definitions that sdcgovernance validates against.
+- **AppGen** - generated applications can call `validate_governance()` at data entry boundaries.
+- **SDC Agents** - reference implementations showing how to wire governance MCP tools into agentic workflows using Default project governance models. Customer agents connect to the same MCP server and use the tools however they want.
+
+## Status
+
+Pre-alpha. Planning phase. See [PLANNING.md](PLANNING.md) for the architecture and implementation roadmap.
+
+## Dependencies
+
+- `rdflib` - RDF/PROV record generation
+- `pyshacl` - SHACL constraint validation
+
+## License
+
+Apache 2.0

sdcgovernance-4.0.0/pyproject.toml

@@ -0,0 +1,46 @@
+[build-system]
+requires = ["setuptools>=68.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "sdcgovernance"
+version = "4.0.0"
+description = "W3C standards-based governance validation for Semantic Data Charter instances"
+license = "Apache-2.0"
+requires-python = ">=3.10"
+readme = "README.md"
+authors = [
+    {name = "Semantic Data Charter Foundation"},
+]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Software Development :: Libraries",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+]
+dependencies = [
+    "lxml>=5.0",
+    "rdflib>=7.0",
+    "pyshacl>=0.25",
+]
+
+[project.optional-dependencies]
+dev = [
+    "pytest>=8.0",
+    "pytest-cov",
+]
+
+[project.urls]
+Homepage = "https://semanticdatacharter.com"
+Repository = "https://github.com/SemanticDataCharter/sdcgovernance"
+Issues = "https://github.com/SemanticDataCharter/sdcgovernance/issues"
+
+[project.scripts]
+sdcgovernance = "sdcgovernance.mcp_server:main"
+
+[tool.setuptools.packages.find]
+where = ["src"]

sdcgovernance-4.0.0/setup.cfg

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

sdcgovernance-4.0.0/src/sdcgovernance/__init__.py

@@ -0,0 +1,104 @@
+"""
+sdcgovernance - W3C standards-based governance advisory engine for SDC instances.
+
+Validates governance content in XML data instances against governance
+components defined in the SDC data model. If the model defines governance
+(workflow, attestation, party/role, provenance/audit), the instance must
+carry that governance content - and this library validates it.
+
+Returns decisions using OASIS XACML semantics: PERMIT, DENY, or INDETERMINATE.
+
+sdcgovernance is independent from sdcvalidator. Both libraries read the schema
+from the instance. Agents call each one independently, at different points in
+a workflow, in whatever order the operational logic requires.
+
+No framework dependency. No middleware. A function call.
+
+Install from PyPI::
+
+    pip install sdcgovernance
+
+Basic usage::
+
+    from sdcgovernance import validate_governance
+
+    result = validate_governance("model.xsd", "instance.xml")
+    print(result.decision)   # PERMIT, DENY, INDETERMINATE
+    print(result.errors)     # list of governance validation errors
+
+See https://github.com/SemanticDataCharter/sdcgovernance for documentation.
+"""
+
+__version__ = "4.0.0a1"
+
+from sdcgovernance.engine import GovernanceEngine
+from sdcgovernance.model_inspector import GovernanceModel, inspect_model
+from sdcgovernance.receipts import (
+    Decision,
+    GovernanceResult,
+    Obligation,
+    Receipt,
+    ReceiptChain,
+    StatusCode,
+)
+
+__all__ = [
+    "validate_governance",
+    "inspect_model",
+    "Decision",
+    "GovernanceEngine",
+    "GovernanceModel",
+    "GovernanceResult",
+    "Obligation",
+    "Receipt",
+    "ReceiptChain",
+    "StatusCode",
+]
+
+
+def validate_governance(
+    schema_path: str,
+    instance_path: str | None = None,
+) -> GovernanceResult:
+    """
+    Validate governance content in an SDC instance against its model.
+
+    This is the primary public API. It inspects the model for governance
+    components and, if an instance is provided, validates the governance
+    content in the instance against the model's requirements.
+
+    Args:
+        schema_path: Path to the SDC data model XSD file.
+        instance_path: Path to the XML instance file. If None, only
+            model inspection is performed (returns which governance
+            dimensions are defined).
+
+    Returns:
+        GovernanceResult with XACML decision and details.
+    """
+    # Phase 1: Model inspection
+    model = inspect_model(schema_path)
+
+    if not model.has_governance:
+        return GovernanceResult(
+            decision=Decision.NOT_APPLICABLE,
+            has_governance=False,
+            status_code=StatusCode.OK,
+            dimensions_validated=model.active_dimensions,
+        )
+
+    # Phase 1 without instance: report what governance exists
+    if instance_path is None:
+        return GovernanceResult(
+            decision=Decision.PERMIT,
+            has_governance=True,
+            dimensions_validated=model.active_dimensions,
+        )
+
+    # Instance validation will be implemented in Phases 2-4
+    # For now, return PERMIT with governance model info
+    return GovernanceResult(
+        decision=Decision.PERMIT,
+        has_governance=True,
+        dimensions_validated=model.active_dimensions,
+    )