docassert 0.5.0__tar.gz → 0.6.0__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docassert
-Version: 0.5.0
+Version: 0.6.0
 Summary: Unit testing for business documents — validate structured Markdown docs against a configurable audit standard.
 Author: C4G Enterprises Inc.
 License: Apache-2.0
@@ -33,7 +33,9 @@ Requires-Dist: python-docx>=1.1; extra == "convert"
 Requires-Dist: pypdf>=4.0; extra == "convert"
 Provides-Extra: dev
 Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
 Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
 Dynamic: license-file
 
 # docassert
@@ -49,7 +51,8 @@ semantic checks that advise. Requirements trace end to end, and project status i
 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.
+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**.
 
 ## Install
 
@@ -89,7 +92,7 @@ flagged as TODOs, never invented). The skill's source is
 | `docassert consistency` | Cross-document checks: referential integrity, coverage, required links, profile completeness. Reports: `--junit` / `--markdown` / `--json`. |
 | `docassert rtm [--project ID]` | Requirements traceability matrix (Markdown or CSV). |
 | `docassert status [--project ID] [--index]` | Derived project status (md / json / html). |
-| `docassert pages --out DIR` | Build the portfolio site (index + a page per project). |
+| `docassert pages --out DIR` | Build the portfolio site (index + a page per project + shields.io badge endpoints `badge.json` / `badges/<ID>.json`). |
 | `docassert projects [--out] [--check]` | Generate / verify the project registry. |
 | `docassert new <kind> --project ID` | Scaffold a document from its template with identity filled in (`new project --code XYZ` auto-numbers the id); suggests the next free item ids. |
 | `docassert init [DIR]` | Scaffold the default config into a repo. |

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

@@ -11,7 +11,8 @@ semantic checks that advise. Requirements trace end to end, and project status i
 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.
+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**.
 
 ## Install
 
@@ -51,7 +52,7 @@ flagged as TODOs, never invented). The skill's source is
 | `docassert consistency` | Cross-document checks: referential integrity, coverage, required links, profile completeness. Reports: `--junit` / `--markdown` / `--json`. |
 | `docassert rtm [--project ID]` | Requirements traceability matrix (Markdown or CSV). |
 | `docassert status [--project ID] [--index]` | Derived project status (md / json / html). |
-| `docassert pages --out DIR` | Build the portfolio site (index + a page per project). |
+| `docassert pages --out DIR` | Build the portfolio site (index + a page per project + shields.io badge endpoints `badge.json` / `badges/<ID>.json`). |
 | `docassert projects [--out] [--check]` | Generate / verify the project registry. |
 | `docassert new <kind> --project ID` | Scaffold a document from its template with identity filled in (`new project --code XYZ` auto-numbers the id); suggests the next free item ids. |
 | `docassert init [DIR]` | Scaffold the default config into a repo. |

{docassert-0.5.0 → docassert-0.6.0}/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.5.0"
+__version__ = "0.6.0"

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

@@ -226,13 +226,21 @@ def cmd_pages(args: argparse.Namespace) -> int:
     index = status_mod.build_index(docs_dir)
     (out / "index.html").write_text(status_mod.render_index_html(index))
 
+    # shields.io endpoint badges: one for the portfolio, one per project
+    # (https://img.shields.io/endpoint?url=<site>/badge.json)
+    (out / "badge.json").write_text(
+        status_mod.render_badge_json(index["overall"]["rag"]))
+    (out / "badges").mkdir(exist_ok=True)
+
     plist = projects_mod.load_projects(docs_dir)
     for p in plist:
         model = status_mod.build_status(docs_dir, project=p["id"])
         (out / f"{p['id']}.html").write_text(status_mod.render_html(model))
+        (out / "badges" / f"{p['id']}.json").write_text(
+            status_mod.render_badge_json(model["rag"], label=p["code"].lower()))
 
     (out / "RTM.md").write_text(rtm.render_markdown(build_graph(docs_dir)))
-    print(f"docassert: wrote {out}/ — index + {len(plist)} project page(s) + RTM.md "
+    print(f"docassert: wrote {out}/ — index + {len(plist)} project page(s) + badges + RTM.md "
           f"(portfolio: {index['overall']['rag']})")
     return 0
 

{docassert-0.5.0 → docassert-0.6.0}/docassert/consistency.py

@@ -63,7 +63,8 @@ def check_referential_integrity(graph) -> CheckResult:
 
 def check_required_links(graph, config) -> CheckResult:
     required = config.get("required_links", {})
-    approved_orphans, draft_orphans = [], []
+    approved_orphans: list[str] = []
+    draft_orphans: list[str] = []
     for item in graph.all_items():
         relation = required.get(item.type)
         if relation and not item.targets(relation):
@@ -79,7 +80,8 @@ def check_required_links(graph, config) -> CheckResult:
 
 
 def check_coverage(graph, config) -> CheckResult:
-    approved_gaps, draft_gaps = [], []
+    approved_gaps: list[str] = []
+    draft_gaps: list[str] = []
     for rule in config.get("coverage", []):
         parent_prefix, relation = rule["parent"], rule["relation"]
         by_prefix = rule.get("by_prefix")

{docassert-0.5.0 → docassert-0.6.0}/docassert/profiles.py

@@ -73,7 +73,7 @@ def completeness(profile: dict, documents: list[dict], project_status: str) -> d
     """
     by_kind: dict[str, list[dict]] = {}
     for d in documents:
-        by_kind.setdefault(d.get("kind"), []).append(d)
+        by_kind.setdefault(str(d.get("kind") or ""), []).append(d)
 
     required = [{"kind": k, "state": _kind_state(k, by_kind)} for k in profile["required"]]
     recommended = [{"kind": k, "state": _kind_state(k, by_kind)} for k in profile["recommended"]]

{docassert-0.5.0 → docassert-0.6.0}/docassert/semantic.py

@@ -69,7 +69,7 @@ def _grade(prompt: str, content: str, model: str) -> dict:
             "content": f"AUDIT CRITERION:\n{prompt}\n\nDOCUMENT:\n{content}",
         }],
     )
-    text = "".join(block.text for block in message.content
+    text = "".join(getattr(block, "text", "") for block in message.content
                    if getattr(block, "type", None) == "text").strip()
     # tolerate models that wrap JSON in prose or fences
     start, end = text.find("{"), text.rfind("}")

{docassert-0.5.0 → docassert-0.6.0}/docassert/status.py

@@ -128,9 +128,9 @@ def build_status(documents_dir=DOCUMENTS_DIR, project: str | None = None) -> dic
     else:
         docs = all_docs
 
-    id_index = {}
+    id_index: dict[str, list[str]] = {}
     for d in all_docs:                       # uniqueness is always global
-        id_index.setdefault(d.id, []).append(d.path)
+        id_index.setdefault(d.id or "", []).append(d.path)
 
     documents = [{
         "kind": d.kind,
@@ -460,6 +460,14 @@ def render_html(model) -> str:
 
 
 _RAG_COLOR = {"green": "var(--ok)", "amber": "var(--amber)", "red": "var(--bad)"}
+_BADGE_COLOR = {"green": "brightgreen", "amber": "orange", "red": "red"}
+
+
+def render_badge_json(rag: str, label: str = "pmo docs") -> str:
+    """A shields.io endpoint payload (https://shields.io/badges/endpoint-badge),
+    so a README can carry a live derived-status badge."""
+    return json.dumps({"schemaVersion": 1, "label": label,
+                       "message": rag, "color": _BADGE_COLOR[rag]}) + "\n"
 
 
 def _index_card(p, esc) -> str:

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: docassert
-Version: 0.5.0
+Version: 0.6.0
 Summary: Unit testing for business documents — validate structured Markdown docs against a configurable audit standard.
 Author: C4G Enterprises Inc.
 License: Apache-2.0
@@ -33,7 +33,9 @@ Requires-Dist: python-docx>=1.1; extra == "convert"
 Requires-Dist: pypdf>=4.0; extra == "convert"
 Provides-Extra: dev
 Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov>=5.0; extra == "dev"
 Requires-Dist: ruff>=0.6; extra == "dev"
+Requires-Dist: mypy>=1.10; extra == "dev"
 Dynamic: license-file
 
 # docassert
@@ -49,7 +51,8 @@ semantic checks that advise. Requirements trace end to end, and project status i
 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.
+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**.
 
 ## Install
 
@@ -89,7 +92,7 @@ flagged as TODOs, never invented). The skill's source is
 | `docassert consistency` | Cross-document checks: referential integrity, coverage, required links, profile completeness. Reports: `--junit` / `--markdown` / `--json`. |
 | `docassert rtm [--project ID]` | Requirements traceability matrix (Markdown or CSV). |
 | `docassert status [--project ID] [--index]` | Derived project status (md / json / html). |
-| `docassert pages --out DIR` | Build the portfolio site (index + a page per project). |
+| `docassert pages --out DIR` | Build the portfolio site (index + a page per project + shields.io badge endpoints `badge.json` / `badges/<ID>.json`). |
 | `docassert projects [--out] [--check]` | Generate / verify the project registry. |
 | `docassert new <kind> --project ID` | Scaffold a document from its template with identity filled in (`new project --code XYZ` auto-numbers the id); suggests the next free item ids. |
 | `docassert init [DIR]` | Scaffold the default config into a repo. |

{docassert-0.5.0 → docassert-0.6.0}/docassert.egg-info/SOURCES.txt

@@ -90,6 +90,7 @@ docassert/_data/templates/runbook.template.md
 docassert/_data/templates/status-report.template.md
 docassert/_data/templates/test-cases.template.md
 docassert/_data/templates/user-story.template.md
+tests/test_badge.py
 tests/test_config.py
 tests/test_consistency.py
 tests/test_defects.py

{docassert-0.5.0 → docassert-0.6.0}/docassert.egg-info/requires.txt

@@ -11,4 +11,6 @@ pypdf>=4.0
 
 [dev]
 pytest>=8.0
+pytest-cov>=5.0
 ruff>=0.6
+mypy>=1.10

{docassert-0.5.0 → docassert-0.6.0}/pyproject.toml

@@ -29,7 +29,7 @@ dependencies = [
 [project.optional-dependencies]
 ai = ["anthropic>=0.40"]
 convert = ["python-docx>=1.1", "pypdf>=4.0"]   # source extraction for doc-to-pmo
-dev = ["pytest>=8.0", "ruff>=0.6"]
+dev = ["pytest>=8.0", "pytest-cov>=5.0", "ruff>=0.6", "mypy>=1.10"]
 
 [project.urls]
 Homepage = "https://docassert.com"
@@ -69,3 +69,20 @@ target-version = "py310"
 select = ["E", "F", "I", "W", "B", "UP"]
 # Long lines are common in the descriptive check messages and sample content.
 ignore = ["E501"]
+
+[tool.mypy]
+files = ["docassert"]
+python_version = "3.10"
+warn_unused_ignores = true
+warn_redundant_casts = true
+
+[[tool.mypy.overrides]]
+module = ["frontmatter", "docx", "pypdf", "yaml", "jsonschema", "anthropic"]
+ignore_missing_imports = true
+
+[tool.coverage.run]
+source = ["docassert"]
+
+[tool.coverage.report]
+# Keep the gate honest: fail CI if coverage drops below the floor.
+fail_under = 80

docassert-0.6.0/tests/test_badge.py

@@ -0,0 +1,26 @@
+"""Tests for the shields.io status-badge endpoint output."""
+import json
+from pathlib import Path
+
+from docassert import status as S
+from docassert.cli import main
+
+ROOT = Path(__file__).resolve().parent.parent
+
+
+def test_badge_payload_shape_and_colors():
+    for rag, color in (("green", "brightgreen"), ("amber", "orange"), ("red", "red")):
+        data = json.loads(S.render_badge_json(rag))
+        assert data == {"schemaVersion": 1, "label": "pmo docs",
+                        "message": rag, "color": color}
+    assert json.loads(S.render_badge_json("green", label="aur"))["label"] == "aur"
+
+
+def test_pages_emits_badges(tmp_path, monkeypatch):
+    monkeypatch.chdir(ROOT)
+    out = tmp_path / "site"
+    assert main(["pages", "--out", str(out)]) == 0
+    overall = json.loads((out / "badge.json").read_text())
+    assert overall["schemaVersion"] == 1 and overall["message"] in {"green", "amber", "red"}
+    aur = json.loads((out / "badges" / "PRJ-001-AUR.json").read_text())
+    assert aur["label"] == "aur" and aur["message"] in {"green", "amber", "red"}