docassert 0.6.0__tar.gz → 0.7.1__tar.gz

{docassert-0.6.0/docassert.egg-info → docassert-0.7.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docassert
-Version: 0.6.0
+Version: 0.7.1
 Summary: Unit testing for business documents — validate structured Markdown docs against a configurable audit standard.
 Author: C4G Enterprises Inc.
 License: Apache-2.0
@@ -44,6 +44,8 @@ Dynamic: license-file
 [![Python](https://img.shields.io/pypi/pyversions/docassert)](https://pypi.org/project/docassert/)
 [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
 
+![docassert demo — a weak charter is blocked, fixed, and cleared](https://raw.githubusercontent.com/c4g-john/docassert/main/docs/demo.svg)
+
 **Unit testing for business documents.** Validate structured Markdown documents
 (charters, BRDs, PRDs, risk registers, …) against a configurable audit standard:
 deterministic structural checks that gate a merge, plus optional AI-graded
@@ -52,7 +54,7 @@ derived from the documents rather than self-reported.
 
 docassert is the reference implementation of **[PMO as Code](https://c4g-john.github.io/pmo-as-code/)** —
 a vendor-neutral standard for running a PMO from version-controlled, declarative
-files. It implements the [PMO as Code specification](https://github.com/c4g-john/pmo-as-code-spec) **v0.1**.
+files. It implements the [PMO as Code specification](https://github.com/c4g-john/pmo-as-code-spec) **v0.2**.
 
 ## Install
 
@@ -117,6 +119,9 @@ kind is adding a trio — no code for the common cases.
 - **Structural — deterministic, blocking.** Required fields and sections,
   measurable success criteria, risks with owner + mitigation, resolving
   references, unique ids. Plain Python, reliable enough to gate a merge.
+  Within this tier, *integrity* checks (malformed items, bad types, duplicate
+  ids) block at any status, while *completeness* checks relax to advisory on
+  `status: draft` and gate once a document is proposed — WIP is never punished.
 - **Semantic — AI-graded, advisory.** Scored via the Anthropic API and posted to
   the PR — never blocking. Set `ANTHROPIC_API_KEY` to enable; skipped otherwise.
 

{docassert-0.6.0 → docassert-0.7.1}/README.md

@@ -4,6 +4,8 @@
 [![Python](https://img.shields.io/pypi/pyversions/docassert)](https://pypi.org/project/docassert/)
 [![License](https://img.shields.io/badge/license-Apache--2.0-blue)](LICENSE)
 
+![docassert demo — a weak charter is blocked, fixed, and cleared](https://raw.githubusercontent.com/c4g-john/docassert/main/docs/demo.svg)
+
 **Unit testing for business documents.** Validate structured Markdown documents
 (charters, BRDs, PRDs, risk registers, …) against a configurable audit standard:
 deterministic structural checks that gate a merge, plus optional AI-graded
@@ -12,7 +14,7 @@ derived from the documents rather than self-reported.
 
 docassert is the reference implementation of **[PMO as Code](https://c4g-john.github.io/pmo-as-code/)** —
 a vendor-neutral standard for running a PMO from version-controlled, declarative
-files. It implements the [PMO as Code specification](https://github.com/c4g-john/pmo-as-code-spec) **v0.1**.
+files. It implements the [PMO as Code specification](https://github.com/c4g-john/pmo-as-code-spec) **v0.2**.
 
 ## Install
 
@@ -77,6 +79,9 @@ kind is adding a trio — no code for the common cases.
 - **Structural — deterministic, blocking.** Required fields and sections,
   measurable success criteria, risks with owner + mitigation, resolving
   references, unique ids. Plain Python, reliable enough to gate a merge.
+  Within this tier, *integrity* checks (malformed items, bad types, duplicate
+  ids) block at any status, while *completeness* checks relax to advisory on
+  `status: draft` and gate once a document is proposed — WIP is never punished.
 - **Semantic — AI-graded, advisory.** Scored via the Anthropic API and posted to
   the PR — never blocking. Set `ANTHROPIC_API_KEY` to enable; skipped otherwise.
 

{docassert-0.6.0 → docassert-0.7.1}/docassert/__init__.py

@@ -5,4 +5,4 @@ standard: deterministic structural checks that gate a merge, plus optional
 AI-graded semantic checks that advise.
 """
 
-__version__ = "0.6.0"
+__version__ = "0.7.1"

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/adr.criteria.yaml

@@ -18,9 +18,13 @@ checks:
     type: structural
     blocking: true
     description: Frontmatter is valid against schema/adr.schema.json.
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
   - id: items-well-formed
     type: structural
@@ -28,7 +32,7 @@ checks:
     description: Every decision is a valid **ADR-###** item.
   - id: adr-items-have-status
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every decision declares a valid Status (proposed | accepted | superseded | deprecated | rejected).
   - id: unique-id
     type: structural

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/benefits-realization.criteria.yaml

@@ -16,13 +16,17 @@ checks:
     type: structural
     blocking: true
     description: Frontmatter is valid against schema/benefits-realization.schema.json.
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
   - id: measurable-items
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every benefit states a measurable target.
   - id: unique-id
     type: structural

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/brd.criteria.yaml

@@ -16,9 +16,13 @@ checks:
     type: structural
     blocking: true
     description: Frontmatter is valid against schema/brd.schema.json.
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
   - id: items-well-formed
     type: structural

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/business-case.criteria.yaml

@@ -13,9 +13,13 @@ checks:
     type: structural
     blocking: true
     description: Frontmatter is valid against schema/business-case.schema.json.
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
   - id: unique-id
     type: structural

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/charter.criteria.yaml

@@ -26,19 +26,23 @@ checks:
     blocking: true
     description: Frontmatter is present and valid against schema/charter.schema.json.
 
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
 
   - id: measurable-success-criteria
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every Success Criteria bullet states a measurable threshold (number, %, currency, or date).
 
   - id: risks-have-owner-and-mitigation
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every Risks bullet names an Owner and a Mitigation.
 
   - id: dates-consistent

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/data-migration-plan.criteria.yaml

@@ -14,13 +14,17 @@ checks:
     type: structural
     blocking: true
     description: Frontmatter is valid against schema/data-migration-plan.schema.json.
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
   - id: mapping-table
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: The Field Mapping section contains a mapping table.
   - id: unique-id
     type: structural

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/frnfr.criteria.yaml

@@ -17,9 +17,13 @@ checks:
     type: structural
     blocking: true
     description: Frontmatter is valid against schema/frnfr.schema.json.
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
   - id: items-well-formed
     type: structural

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/hypercare-plan.criteria.yaml

@@ -13,13 +13,17 @@ checks:
     type: structural
     blocking: true
     description: Frontmatter is valid against schema/hypercare-plan.schema.json.
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
   - id: measurable-exit-criteria
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every hypercare exit criterion states a measurable threshold.
   - id: unique-id
     type: structural

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/post-implementation-review.criteria.yaml

@@ -14,9 +14,13 @@ checks:
     type: structural
     blocking: true
     description: Frontmatter is valid against schema/post-implementation-review.schema.json.
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
   - id: unique-id
     type: structural

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/prd.criteria.yaml

@@ -17,9 +17,13 @@ checks:
     type: structural
     blocking: true
     description: Frontmatter is valid against schema/prd.schema.json.
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
   - id: items-well-formed
     type: structural

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/project.criteria.yaml

@@ -16,6 +16,10 @@ checks:
     blocking: true
     description: Frontmatter is present and valid against schema/project.schema.json.
 
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: project-id-format
     type: structural
     blocking: true
@@ -23,7 +27,7 @@ checks:
 
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
 
   - id: unique-id

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/qa-test-plan.criteria.yaml

@@ -13,13 +13,17 @@ checks:
     type: structural
     blocking: true
     description: Frontmatter is valid against schema/qa-test-plan.schema.json.
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
   - id: measurable-exit-criteria
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every exit criterion states a measurable threshold.
   - id: unique-id
     type: structural

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/raci-stakeholder.criteria.yaml

@@ -10,13 +10,17 @@ checks:
     type: structural
     blocking: true
     description: Frontmatter is valid against schema/raci-stakeholder.schema.json.
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
   - id: raci-one-accountable
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every activity in the RACI Matrix has exactly one Accountable (A) role.
   - id: unique-id
     type: structural

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/release-cutover-plan.criteria.yaml

@@ -16,13 +16,17 @@ checks:
     type: structural
     blocking: true
     description: Frontmatter is valid against schema/release-cutover-plan.schema.json.
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
   - id: numbered-steps
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Cutover Steps is an ordered list of at least two numbered steps.
   - id: unique-id
     type: structural

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/risk-register.criteria.yaml

@@ -14,9 +14,13 @@ checks:
     type: structural
     blocking: true
     description: Frontmatter is valid against schema/risk-register.schema.json.
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
   - id: items-well-formed
     type: structural
@@ -24,7 +28,7 @@ checks:
     description: Every risk is a valid **RISK-###** item.
   - id: risk-items-complete
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every risk states a Probability, Impact, Owner, and Response.
   - id: unique-id
     type: structural

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/rollback-plan.criteria.yaml

@@ -15,13 +15,17 @@ checks:
     type: structural
     blocking: true
     description: Frontmatter is valid against schema/rollback-plan.schema.json.
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
   - id: numbered-steps
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Rollback Steps is an ordered list of at least two numbered steps.
   - id: unique-id
     type: structural

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/runbook.criteria.yaml

@@ -16,13 +16,17 @@ checks:
     type: structural
     blocking: true
     description: Frontmatter is valid against schema/runbook.schema.json.
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
   - id: numbered-steps
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Procedures is an ordered list of at least two numbered steps.
   - id: unique-id
     type: structural

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/status-report.criteria.yaml

@@ -12,13 +12,17 @@ checks:
     type: structural
     blocking: true
     description: Frontmatter is valid (includes a period date and a green/amber/red rag).
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
   - id: references-risk
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: The Risks & Issues section cites at least one RISK-### from the register.
   - id: unique-id
     type: structural

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/test-cases.criteria.yaml

@@ -14,9 +14,13 @@ checks:
     type: structural
     blocking: true
     description: Frontmatter is valid against schema/test-cases.schema.json.
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
   - id: items-well-formed
     type: structural

{docassert-0.6.0 → docassert-0.7.1}/docassert/_data/criteria/user-story.criteria.yaml

@@ -14,9 +14,13 @@ checks:
     type: structural
     blocking: true
     description: Frontmatter is valid against schema/user-story.schema.json.
+  - id: frontmatter-complete
+    type: structural
+    blocking: once-proposed
+    description: Every schema-required frontmatter field is present (advisory while draft).
   - id: required-sections
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every required section is present and non-empty.
   - id: items-well-formed
     type: structural
@@ -24,7 +28,7 @@ checks:
     description: Every story is a valid **US-###** item.
   - id: story-format
     type: structural
-    blocking: true
+    blocking: once-proposed
     description: Every story follows "As a … I want … so that …".
   - id: unique-id
     type: structural

{docassert-0.6.0 → docassert-0.7.1}/docassert/cli.py

@@ -300,18 +300,19 @@ def main(argv: list[str] | None = None) -> int:
         sp.add_argument("--documents-dir", default=DEFAULT_DOCUMENTS_DIR,
                         help=f"Documents tree to read (default: {DEFAULT_DOCUMENTS_DIR}/).")
 
+    def report_opts(sp: argparse.ArgumentParser) -> None:
+        sp.add_argument("--junit", help="Write a JUnit XML report to this path.")
+        sp.add_argument("--markdown", help="Write a PR-comment markdown report to this path.")
+        sp.add_argument("--json", help="Write a machine-readable JSON report to this path.")
+
     v = sub.add_parser("validate", help="Validate documents against their criteria.")
     v.add_argument("paths", nargs="+", help="Markdown files or globs.")
-    v.add_argument("--junit", help="Write a JUnit XML report to this path.")
-    v.add_argument("--markdown", help="Write a PR-comment markdown report to this path.")
-    v.add_argument("--json", help="Write a machine-readable JSON report to this path.")
+    report_opts(v)
     docs_dir_opt(v)
     v.set_defaults(func=cmd_validate)
 
     c = sub.add_parser("consistency", help="Check cross-document traceability.")
-    c.add_argument("--junit", help="Write a JUnit XML report to this path.")
-    c.add_argument("--markdown", help="Write a PR-comment markdown report to this path.")
-    c.add_argument("--json", help="Write a machine-readable JSON report to this path.")
+    report_opts(c)
     c.add_argument("--no-semantic", action="store_true",
                    help="Skip AI alignment (structural consistency only).")
     docs_dir_opt(c)

{docassert-0.6.0 → docassert-0.7.1}/docassert/report.py

@@ -12,6 +12,11 @@ _CROSS = "✗"
 _DASH = "—"
 
 
+def _all(results_by_doc: dict[str, list[CheckResult]]) -> list[CheckResult]:
+    """Every result across every document, flattened."""
+    return [r for rs in results_by_doc.values() for r in rs]
+
+
 def _mark(r: CheckResult) -> str:
     if r.kind == "semantic" and r.score is None:
         return "○"  # ○ skipped/unavailable
@@ -31,7 +36,7 @@ def console(results_by_doc: dict[str, list[CheckResult]]) -> str:
 
 
 def summary_line(results_by_doc: dict[str, list[CheckResult]]) -> str:
-    blocking = sum(1 for rs in results_by_doc.values() for r in rs if r.is_blocking_failure)
+    blocking = sum(1 for r in _all(results_by_doc) if r.is_blocking_failure)
     docs = len(results_by_doc)
     if blocking:
         return f"{_CROSS} {blocking} blocking failure(s) across {docs} document(s) {_DASH} merge blocked."
@@ -51,7 +56,7 @@ def json_report(results_by_doc: dict[str, list[CheckResult]]) -> str:
         } for r in results]
         for path, results in results_by_doc.items()
     }
-    all_results = [r for rs in results_by_doc.values() for r in rs]
+    all_results = _all(results_by_doc)
     summary = {
         "documents": len(results_by_doc),
         "checks": len(all_results),
@@ -89,9 +94,9 @@ def markdown(results_by_doc: dict[str, list[CheckResult]],
 
 
 def junit(results_by_doc: dict[str, list[CheckResult]]) -> str:
-    total = sum(len(rs) for rs in results_by_doc.values())
-    failures = sum(1 for rs in results_by_doc.values()
-                   for r in rs if r.is_blocking_failure)
+    all_results = _all(results_by_doc)
+    total = len(all_results)
+    failures = sum(1 for r in all_results if r.is_blocking_failure)
     suites = ET.Element("testsuites", tests=str(total), failures=str(failures))
     for path, results in results_by_doc.items():
         suite = ET.SubElement(suites, "testsuite", name=path,

docassert-0.7.1/docassert/status/__init__.py

@@ -0,0 +1,26 @@
+"""Status derivation and rendering, split into `derive` (model) and `render`
+(views). This module re-exports the public API so existing imports are unchanged.
+"""
+from .derive import (
+    APPROVED,
+    DOCUMENTS_DIR,
+    build_index,
+    build_status,
+    completeness_report,
+    derive_rag,
+)
+from .render import (
+    render_badge_json,
+    render_html,
+    render_index_html,
+    render_index_markdown,
+    render_json,
+    render_markdown,
+)
+
+__all__ = [
+    "DOCUMENTS_DIR", "APPROVED",
+    "build_status", "build_index", "completeness_report", "derive_rag",
+    "render_markdown", "render_json", "render_html",
+    "render_index_markdown", "render_index_html", "render_badge_json",
+]