evidencematrix 0.1.0__py3-none-any.whl

evidencematrix/__init__.py

@@ -0,0 +1,18 @@
+"""A deterministic source-coverage audit tool for multi-source datasets."""
+
+from evidencematrix.matrix import build_matrix, summarize_matrix
+from evidencematrix.model import CoverageStatus, SourceAvailability
+from evidencematrix.parser import load_manifest
+from evidencematrix.validation import ManifestError, validate_document
+
+__all__ = [
+    "CoverageStatus",
+    "ManifestError",
+    "SourceAvailability",
+    "build_matrix",
+    "load_manifest",
+    "summarize_matrix",
+    "validate_document",
+]
+
+__version__ = "0.1.0"

evidencematrix/audit.py

@@ -0,0 +1,25 @@
+"""Coverage finding selection without subjective scoring."""
+
+from __future__ import annotations
+
+from evidencematrix.model import (
+    COVERAGE_STATUS_ORDER,
+    UNRESOLVED_STATUSES,
+    AuditReport,
+    CoverageRecord,
+)
+
+
+def audit_matrix(matrix: tuple[CoverageRecord, ...]) -> AuditReport:
+    """Return unresolved relationships; supported and not-applicable rows are excluded."""
+
+    counts = {status.value: 0 for status in COVERAGE_STATUS_ORDER}
+    for record in matrix:
+        counts[record.status.value] += 1
+    findings = tuple(record for record in matrix if record.status in UNRESOLVED_STATUSES)
+    return AuditReport(
+        relationship_count=len(matrix),
+        status_counts=counts,
+        finding_count=len(findings),
+        findings=findings,
+    )

evidencematrix/cli.py

@@ -0,0 +1,101 @@
+"""Command line interface for EvidenceMatrix."""
+
+from __future__ import annotations
+
+import argparse
+import json
+import sys
+from collections.abc import Sequence
+from pathlib import Path
+
+from evidencematrix.audit import audit_matrix
+from evidencematrix.matrix import build_matrix, summarize_matrix
+from evidencematrix.output import (
+    audit_to_dict,
+    build_artifacts,
+    summary_to_dict,
+    write_artifacts,
+)
+from evidencematrix.parser import load_manifest
+from evidencematrix.validation import ManifestError
+
+
+def _parser() -> argparse.ArgumentParser:
+    parser = argparse.ArgumentParser(
+        prog="evidencematrix",
+        description="Build deterministic entity-by-source coverage audits.",
+    )
+    commands = parser.add_subparsers(dest="command", required=True)
+    for command in ("validate", "build", "audit", "summary"):
+        subparser = commands.add_parser(command)
+        subparser.add_argument(
+            "path", type=Path, help="manifest file or directory containing one manifest"
+        )
+        if command == "build":
+            subparser.add_argument("--output", type=Path, default=Path("evidencematrix-output"))
+        if command in {"audit", "summary"}:
+            subparser.add_argument("--format", choices=("text", "json"), default="text")
+    return parser
+
+
+def _status_text(counts: dict[str, int]) -> str:
+    return "\n".join(f"{status}: {count}" for status, count in counts.items())
+
+
+def _run(args: argparse.Namespace) -> int:
+    manifest = load_manifest(args.path)
+    if args.command == "validate":
+        print(f"valid: {args.path}")
+        return 0
+
+    matrix = build_matrix(manifest)
+    summary = summarize_matrix(manifest, matrix)
+    if args.command == "build":
+        artifacts = build_artifacts(manifest, matrix, summary)
+        paths = write_artifacts(artifacts, args.output)
+        print(f"built {len(paths)} artifacts: {args.output}")
+        return 0
+    if args.command == "audit":
+        report = audit_matrix(matrix)
+        if args.format == "json":
+            print(json.dumps(audit_to_dict(matrix), ensure_ascii=False, sort_keys=True, indent=2))
+        else:
+            print(f"Relationships: {report.relationship_count}")
+            print(f"Unresolved findings: {report.finding_count}")
+            print(
+                "\n".join(
+                    f"{status}: {count}"
+                    for status, count in report.status_counts.items()
+                    if status not in {"supported", "not_applicable"}
+                )
+            )
+            print(f"not_applicable (excluded): {report.status_counts['not_applicable']}")
+        return 1 if report.finding_count else 0
+    if args.command == "summary":
+        if args.format == "json":
+            print(
+                json.dumps(summary_to_dict(summary), ensure_ascii=False, sort_keys=True, indent=2)
+            )
+        else:
+            print(f"Entities: {summary.entity_count}")
+            print(f"Sources: {summary.source_count}")
+            print(f"Relationships: {summary.relationship_count}")
+            print(_status_text(summary.status_counts))
+            print(f"Unresolved findings: {summary.finding_count}")
+        return 0
+    raise AssertionError(f"unhandled command: {args.command}")
+
+
+def main(argv: Sequence[str] | None = None) -> int:
+    """Run a CLI command and return its documented process exit code."""
+
+    args = _parser().parse_args(argv)
+    try:
+        return _run(args)
+    except (ManifestError, OSError) as exc:
+        print(f"evidencematrix: error: {exc}", file=sys.stderr)
+        return 2
+
+
+def entrypoint() -> None:
+    raise SystemExit(main())

evidencematrix/matrix.py

@@ -0,0 +1,60 @@
+"""Pure entity-by-source coverage expansion and counting."""
+
+from __future__ import annotations
+
+from evidencematrix.model import (
+    COVERAGE_STATUS_ORDER,
+    UNRESOLVED_STATUSES,
+    CoverageRecord,
+    CoverageStatus,
+    Manifest,
+    SourceAvailability,
+    Summary,
+)
+
+
+def build_matrix(manifest: Manifest) -> tuple[CoverageRecord, ...]:
+    """Expand every entity/source pair, preserving explicit unknowns and gaps."""
+
+    declarations = {(item.entity, item.source): item for item in manifest.coverage}
+    records: list[CoverageRecord] = []
+    for entity in sorted(manifest.entities, key=lambda item: item.id):
+        for source in sorted(manifest.sources, key=lambda item: item.id):
+            declaration = declarations.get((entity.id, source.id))
+            if declaration is not None:
+                status = declaration.status
+                reason = declaration.reason
+            elif source.availability is SourceAvailability.UNAVAILABLE:
+                status = CoverageStatus.SOURCE_UNAVAILABLE
+                reason = "source_declared_unavailable"
+            elif source.availability is SourceAvailability.NOT_IN_RELEASE:
+                status = CoverageStatus.SOURCE_NOT_IN_RELEASE
+                reason = "source_declared_not_in_release"
+            else:
+                status = CoverageStatus.UNKNOWN
+                reason = "coverage_not_declared"
+            records.append(
+                CoverageRecord(
+                    entity_id=entity.id,
+                    source_id=source.id,
+                    source_availability=source.availability,
+                    status=status,
+                    reason=reason,
+                )
+            )
+    return tuple(records)
+
+
+def summarize_matrix(manifest: Manifest, matrix: tuple[CoverageRecord, ...]) -> Summary:
+    """Count matrix rows by status; not-applicable rows are not audit findings."""
+
+    counts = {status.value: 0 for status in COVERAGE_STATUS_ORDER}
+    for record in matrix:
+        counts[record.status.value] += 1
+    return Summary(
+        entity_count=len(manifest.entities),
+        source_count=len(manifest.sources),
+        relationship_count=len(matrix),
+        status_counts=counts,
+        finding_count=sum(counts[status.value] for status in UNRESOLVED_STATUSES),
+    )

evidencematrix/model.py

@@ -0,0 +1,88 @@
+"""Typed, immutable data structures for coverage manifests and reports."""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from enum import StrEnum
+
+
+class SourceAvailability(StrEnum):
+    AVAILABLE = "available"
+    UNAVAILABLE = "unavailable"
+    NOT_IN_RELEASE = "not_in_release"
+    UNKNOWN = "unknown"
+
+
+class CoverageStatus(StrEnum):
+    SUPPORTED = "supported"
+    METADATA_GAP = "metadata_gap"
+    MAPPING_GAP = "mapping_gap"
+    SOURCE_UNAVAILABLE = "source_unavailable"
+    SOURCE_NOT_IN_RELEASE = "source_not_in_release"
+    NOT_APPLICABLE = "not_applicable"
+    UNKNOWN = "unknown"
+
+
+COVERAGE_STATUS_ORDER = tuple(CoverageStatus)
+UNRESOLVED_STATUSES = frozenset(
+    {
+        CoverageStatus.METADATA_GAP,
+        CoverageStatus.MAPPING_GAP,
+        CoverageStatus.SOURCE_UNAVAILABLE,
+        CoverageStatus.SOURCE_NOT_IN_RELEASE,
+        CoverageStatus.UNKNOWN,
+    }
+)
+
+
+@dataclass(frozen=True, slots=True)
+class Entity:
+    id: str
+
+
+@dataclass(frozen=True, slots=True)
+class Source:
+    id: str
+    availability: SourceAvailability
+
+
+@dataclass(frozen=True, slots=True)
+class Coverage:
+    entity: str
+    source: str
+    status: CoverageStatus
+    reason: str | None = None
+
+
+@dataclass(frozen=True, slots=True)
+class Manifest:
+    version: int
+    entities: tuple[Entity, ...]
+    sources: tuple[Source, ...]
+    coverage: tuple[Coverage, ...]
+
+
+@dataclass(frozen=True, slots=True)
+class CoverageRecord:
+    entity_id: str
+    source_id: str
+    source_availability: SourceAvailability
+    status: CoverageStatus
+    reason: str | None
+
+
+@dataclass(frozen=True, slots=True)
+class Summary:
+    entity_count: int
+    source_count: int
+    relationship_count: int
+    status_counts: dict[str, int]
+    finding_count: int
+
+
+@dataclass(frozen=True, slots=True)
+class AuditReport:
+    relationship_count: int
+    status_counts: dict[str, int]
+    finding_count: int
+    findings: tuple[CoverageRecord, ...]

evidencematrix/output.py

@@ -0,0 +1,152 @@
+"""Deterministic machine and human readable report rendering."""
+
+from __future__ import annotations
+
+import csv
+import io
+import json
+from pathlib import Path
+
+from evidencematrix.audit import audit_matrix
+from evidencematrix.model import (
+    COVERAGE_STATUS_ORDER,
+    UNRESOLVED_STATUSES,
+    CoverageRecord,
+    Manifest,
+    Summary,
+)
+
+ARTIFACT_NAMES = (
+    "coverage_matrix.csv",
+    "coverage_report.json",
+    "gap_report.json",
+    "summary.json",
+    "coverage_report.md",
+)
+CSV_FIELDS = ("entity_id", "source_id", "source_availability", "status", "reason")
+
+
+def _json_bytes(value: object) -> bytes:
+    return (json.dumps(value, ensure_ascii=False, sort_keys=True, indent=2) + "\n").encode("utf-8")
+
+
+def record_to_dict(record: CoverageRecord) -> dict[str, str | None]:
+    return {
+        "entity_id": record.entity_id,
+        "source_id": record.source_id,
+        "source_availability": record.source_availability.value,
+        "status": record.status.value,
+        "reason": record.reason,
+    }
+
+
+def summary_to_dict(summary: Summary) -> dict[str, object]:
+    return {
+        "schema_version": 1,
+        "entity_count": summary.entity_count,
+        "source_count": summary.source_count,
+        "relationship_count": summary.relationship_count,
+        "status_counts": summary.status_counts,
+        "finding_count": summary.finding_count,
+    }
+
+
+def audit_to_dict(matrix: tuple[CoverageRecord, ...]) -> dict[str, object]:
+    audit = audit_matrix(matrix)
+    return {
+        "schema_version": 1,
+        "relationship_count": audit.relationship_count,
+        "finding_count": audit.finding_count,
+        "status_counts": {
+            status.value: audit.status_counts[status.value]
+            for status in COVERAGE_STATUS_ORDER
+            if status in UNRESOLVED_STATUSES
+        },
+        "not_applicable_count": audit.status_counts["not_applicable"],
+        "findings": [record_to_dict(item) for item in audit.findings],
+    }
+
+
+def build_artifacts(
+    manifest: Manifest,
+    matrix: tuple[CoverageRecord, ...],
+    summary: Summary,
+) -> dict[str, bytes]:
+    """Render all version 1 artifacts in memory with stable byte representations."""
+
+    csv_output = io.StringIO(newline="")
+    writer = csv.DictWriter(csv_output, fieldnames=CSV_FIELDS, lineterminator="\n")
+    writer.writeheader()
+    for record in matrix:
+        row = record_to_dict(record)
+        writer.writerow({field: "" if row[field] is None else row[field] for field in CSV_FIELDS})
+
+    report = {
+        "schema_version": 1,
+        "version": manifest.version,
+        "entities": [
+            {"id": item.id} for item in sorted(manifest.entities, key=lambda item: item.id)
+        ],
+        "sources": [
+            {"id": item.id, "availability": item.availability.value}
+            for item in sorted(manifest.sources, key=lambda item: item.id)
+        ],
+        "relationships": [record_to_dict(record) for record in matrix],
+    }
+    audit = audit_to_dict(matrix)
+    markdown = [
+        "# EvidenceMatrix coverage report",
+        "",
+        f"- Entities: {summary.entity_count}",
+        f"- Sources: {summary.source_count}",
+        f"- Relationships: {summary.relationship_count}",
+        f"- Unresolved findings: {summary.finding_count}",
+        "",
+        "## Coverage status counts",
+        "",
+    ]
+    markdown.extend(f"- `{status}`: {count}" for status, count in summary.status_counts.items())
+    markdown.extend(
+        [
+            "",
+            "## Unresolved relationships",
+            "",
+            "| Entity | Source | Status | Reason |",
+            "| --- | --- | --- | --- |",
+        ]
+    )
+    if audit["findings"]:
+        for item in audit["findings"]:
+            assert isinstance(item, dict)
+            values = [item["entity_id"], item["source_id"], item["status"], item["reason"] or ""]
+            escaped = [str(value).replace("|", "\\|").replace("\n", " ") for value in values]
+            markdown.append("| " + " | ".join(escaped) + " |")
+    else:
+        markdown.append("| — | — | — | No unresolved relationships |")
+    markdown_text = "\n".join(markdown) + "\n"
+    summary_payload = summary_to_dict(summary)
+
+    return {
+        "coverage_matrix.csv": csv_output.getvalue().encode("utf-8"),
+        "coverage_report.json": _json_bytes(report),
+        "gap_report.json": _json_bytes(audit),
+        "summary.json": _json_bytes(summary_payload),
+        "coverage_report.md": markdown_text.encode("utf-8"),
+    }
+
+
+def write_artifacts(artifacts: dict[str, bytes], output_dir: str | Path) -> tuple[Path, ...]:
+    """Write a complete pre-rendered artifact set to the requested directory."""
+
+    root = Path(output_dir).expanduser()
+    if root.exists() and not root.is_dir():
+        raise OSError(f"output path is not a directory: {root}")
+    root.mkdir(parents=True, exist_ok=True)
+    written: list[Path] = []
+    for name in ARTIFACT_NAMES:
+        destination = root / name
+        temporary = root / f".{name}.tmp"
+        temporary.write_bytes(artifacts[name])
+        temporary.replace(destination)
+        written.append(destination)
+    return tuple(written)

evidencematrix/parser.py

@@ -0,0 +1,88 @@
+"""Offline YAML and JSON manifest loading."""
+
+from __future__ import annotations
+
+import json
+from pathlib import Path
+from typing import Any
+
+import yaml
+
+from evidencematrix.model import Manifest
+from evidencematrix.validation import ManifestError, validate_document
+
+
+class _UniqueKeyLoader(yaml.SafeLoader):
+    def construct_mapping(self, node: yaml.MappingNode, deep: bool = False) -> dict[Any, Any]:
+        self.flatten_mapping(node)
+        result: dict[Any, Any] = {}
+        for key_node, value_node in node.value:
+            key = self.construct_object(key_node, deep=deep)
+            try:
+                duplicate = key in result
+            except TypeError as exc:
+                raise yaml.constructor.ConstructorError(
+                    "while constructing a mapping",
+                    node.start_mark,
+                    "found an unhashable key",
+                    key_node.start_mark,
+                ) from exc
+            if duplicate:
+                raise yaml.constructor.ConstructorError(
+                    "while constructing a mapping",
+                    node.start_mark,
+                    f"found duplicate key {key!r}",
+                    key_node.start_mark,
+                )
+            result[key] = self.construct_object(value_node, deep=deep)
+        return result
+
+
+def _json_object(pairs: list[tuple[str, Any]]) -> dict[str, Any]:
+    result: dict[str, Any] = {}
+    for key, value in pairs:
+        if key in result:
+            raise ValueError(f"duplicate key {key!r}")
+        result[key] = value
+    return result
+
+
+def _manifest_path(path: Path) -> Path:
+    if path.is_dir():
+        candidates = sorted(
+            candidate
+            for candidate in path.iterdir()
+            if candidate.is_file() and candidate.suffix.casefold() in {".yaml", ".yml", ".json"}
+        )
+        if len(candidates) != 1:
+            raise ManifestError(
+                "input directory must contain exactly one .yaml, .yml, or .json manifest; "
+                f"found {len(candidates)}"
+            )
+        return candidates[0]
+    if not path.is_file():
+        raise ManifestError(f"input path is not a file or directory: {path}")
+    if path.suffix.casefold() not in {".yaml", ".yml", ".json"}:
+        raise ManifestError(f"manifest file must end in .yaml, .yml, or .json: {path.name}")
+    return path
+
+
+def _parse_text(text: str, *, suffix: str) -> Any:
+    if suffix.casefold() == ".json":
+        return json.loads(text, object_pairs_hook=_json_object)
+    return yaml.load(text, Loader=_UniqueKeyLoader)
+
+
+def load_manifest(path: str | Path) -> Manifest:
+    """Load and validate one YAML or JSON manifest from a file or directory."""
+
+    selected_path = _manifest_path(Path(path).expanduser())
+    try:
+        text = selected_path.read_text(encoding="utf-8")
+    except (OSError, UnicodeError) as exc:
+        raise ManifestError(f"cannot read manifest {selected_path}: {exc}") from exc
+    try:
+        document = _parse_text(text, suffix=selected_path.suffix)
+    except (json.JSONDecodeError, yaml.YAMLError, ValueError) as exc:
+        raise ManifestError(f"cannot parse manifest {selected_path}: {exc}") from exc
+    return validate_document(document)

evidencematrix/validation.py

@@ -0,0 +1,212 @@
+"""Manifest validation and conversion into the public model."""
+
+from __future__ import annotations
+
+from collections.abc import Mapping
+from typing import Any
+
+from evidencematrix.model import (
+    COVERAGE_STATUS_ORDER,
+    Coverage,
+    CoverageStatus,
+    Entity,
+    Manifest,
+    Source,
+    SourceAvailability,
+)
+
+
+class ManifestError(ValueError):
+    """Raised when an input manifest is malformed or internally inconsistent."""
+
+
+def _mapping(value: Any, *, field: str, errors: list[str]) -> Mapping[str, Any] | None:
+    if not isinstance(value, Mapping):
+        errors.append(f"{field} must be a mapping")
+        return None
+    if any(not isinstance(key, str) for key in value):
+        errors.append(f"{field} keys must be strings")
+        return None
+    return value
+
+
+def _check_fields(
+    value: Mapping[str, Any],
+    *,
+    required: set[str],
+    allowed: set[str],
+    field: str,
+    errors: list[str],
+) -> None:
+    missing = sorted(required - value.keys())
+    unexpected = sorted(value.keys() - allowed)
+    if missing:
+        errors.append(f"{field} is missing required field(s): {', '.join(missing)}")
+    if unexpected:
+        errors.append(f"{field} has unknown field(s): {', '.join(unexpected)}")
+
+
+def _identifier(value: Any, *, field: str, errors: list[str]) -> str | None:
+    if not isinstance(value, str) or not value or value.strip() != value:
+        errors.append(f"{field} must be a non-empty string without surrounding whitespace")
+        return None
+    return value
+
+
+def validate_document(document: Any) -> Manifest:
+    """Validate a parsed manifest document and return immutable typed data."""
+
+    errors: list[str] = []
+    root = _mapping(document, field="manifest", errors=errors)
+    if root is None:
+        raise ManifestError("invalid manifest: " + "; ".join(errors))
+    _check_fields(
+        root,
+        required={"version", "entities", "sources", "coverage"},
+        allowed={"version", "entities", "sources", "coverage"},
+        field="manifest",
+        errors=errors,
+    )
+
+    version = root.get("version")
+    if type(version) is not int or version != 1:
+        errors.append("version must be the integer 1")
+
+    raw_entities = root.get("entities")
+    entities: list[Entity] = []
+    entity_ids: set[str] = set()
+    if not isinstance(raw_entities, list):
+        errors.append("entities must be a list")
+    else:
+        for index, raw_entity in enumerate(raw_entities):
+            field = f"entities[{index}]"
+            entity = _mapping(raw_entity, field=field, errors=errors)
+            if entity is None:
+                continue
+            _check_fields(entity, required={"id"}, allowed={"id"}, field=field, errors=errors)
+            entity_id = _identifier(entity.get("id"), field=f"{field}.id", errors=errors)
+            if entity_id is None:
+                continue
+            if entity_id in entity_ids:
+                errors.append(f"duplicate entity id: {entity_id}")
+            else:
+                entity_ids.add(entity_id)
+                entities.append(Entity(id=entity_id))
+
+    raw_sources = root.get("sources")
+    sources: list[Source] = []
+    source_by_id: dict[str, Source] = {}
+    if not isinstance(raw_sources, list):
+        errors.append("sources must be a list")
+    else:
+        for index, raw_source in enumerate(raw_sources):
+            field = f"sources[{index}]"
+            source = _mapping(raw_source, field=field, errors=errors)
+            if source is None:
+                continue
+            _check_fields(
+                source,
+                required={"id", "availability"},
+                allowed={"id", "availability"},
+                field=field,
+                errors=errors,
+            )
+            source_id = _identifier(source.get("id"), field=f"{field}.id", errors=errors)
+            availability_value = source.get("availability")
+            try:
+                availability = SourceAvailability(availability_value)
+            except (ValueError, TypeError):
+                errors.append(
+                    f"{field}.availability must be one of: "
+                    + ", ".join(item.value for item in SourceAvailability)
+                )
+                availability = None
+            if source_id is None or availability is None:
+                continue
+            if source_id in source_by_id:
+                errors.append(f"duplicate source id: {source_id}")
+                continue
+            parsed_source = Source(id=source_id, availability=availability)
+            source_by_id[source_id] = parsed_source
+            sources.append(parsed_source)
+
+    raw_coverage = root.get("coverage")
+    coverage: list[Coverage] = []
+    seen_pairs: set[tuple[str, str]] = set()
+    if not isinstance(raw_coverage, list):
+        errors.append("coverage must be a list")
+    else:
+        for index, raw_record in enumerate(raw_coverage):
+            field = f"coverage[{index}]"
+            record = _mapping(raw_record, field=field, errors=errors)
+            if record is None:
+                continue
+            _check_fields(
+                record,
+                required={"entity", "source", "status"},
+                allowed={"entity", "source", "status", "reason"},
+                field=field,
+                errors=errors,
+            )
+            entity_id = _identifier(record.get("entity"), field=f"{field}.entity", errors=errors)
+            source_id = _identifier(record.get("source"), field=f"{field}.source", errors=errors)
+            try:
+                status = CoverageStatus(record.get("status"))
+            except (ValueError, TypeError):
+                errors.append(
+                    f"{field}.status is invalid; expected one of: "
+                    + ", ".join(item.value for item in COVERAGE_STATUS_ORDER)
+                )
+                status = None
+            reason = record.get("reason")
+            if reason is not None and (
+                not isinstance(reason, str) or not reason or reason.strip() != reason
+            ):
+                errors.append(f"{field}.reason must be a non-empty string when supplied")
+                reason = None
+            if status is CoverageStatus.SUPPORTED and reason is not None:
+                errors.append(f"{field}.reason is only valid for non-supported coverage")
+            if entity_id is None or source_id is None or status is None:
+                continue
+            if entity_id not in entity_ids:
+                errors.append(f"{field} references unknown entity: {entity_id}")
+            if source_id not in source_by_id:
+                errors.append(f"{field} references unknown source: {source_id}")
+            pair = (entity_id, source_id)
+            if pair in seen_pairs:
+                errors.append(f"duplicate coverage relationship: {entity_id} × {source_id}")
+            else:
+                seen_pairs.add(pair)
+            source = source_by_id.get(source_id)
+            if source is not None:
+                conflicting_availability = {
+                    CoverageStatus.SUPPORTED: {
+                        SourceAvailability.UNAVAILABLE,
+                        SourceAvailability.NOT_IN_RELEASE,
+                    },
+                    CoverageStatus.SOURCE_UNAVAILABLE: {
+                        SourceAvailability.AVAILABLE,
+                        SourceAvailability.NOT_IN_RELEASE,
+                    },
+                    CoverageStatus.SOURCE_NOT_IN_RELEASE: {
+                        SourceAvailability.AVAILABLE,
+                        SourceAvailability.UNAVAILABLE,
+                    },
+                }.get(status, set())
+                if source.availability in conflicting_availability:
+                    errors.append(
+                        f"{field}.status {status.value} conflicts with source availability "
+                        f"{source.availability.value}"
+                    )
+            coverage.append(
+                Coverage(entity=entity_id, source=source_id, status=status, reason=reason)
+            )
+
+    if errors:
+        raise ManifestError("invalid manifest: " + "; ".join(errors))
+    return Manifest(
+        version=version,
+        entities=tuple(entities),
+        sources=tuple(sources),
+        coverage=tuple(coverage),
+    )

evidencematrix-0.1.0.dist-info/METADATA

@@ -0,0 +1,150 @@
+Metadata-Version: 2.4
+Name: evidencematrix
+Version: 0.1.0
+Summary: A deterministic source-coverage audit tool for multi-source datasets
+Author: KageRyo
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/KageRyo/EvidenceMatrix
+Project-URL: Repository, https://github.com/KageRyo/EvidenceMatrix
+Project-URL: Issues, https://github.com/KageRyo/EvidenceMatrix/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Environment :: Console
+Classifier: Intended Audience :: Developers
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Database
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: PyYAML<7,>=6.0
+Dynamic: license-file
+
+# EvidenceMatrix
+
+[![CI](https://github.com/KageRyo/EvidenceMatrix/actions/workflows/ci.yml/badge.svg?branch=main)](https://github.com/KageRyo/EvidenceMatrix/actions/workflows/ci.yml)
+[![PyPI](https://img.shields.io/pypi/v/evidencematrix)](https://pypi.org/project/evidencematrix/)
+[![Latest release](https://img.shields.io/github/v/release/KageRyo/EvidenceMatrix?display_name=tag&sort=semver)](https://github.com/KageRyo/EvidenceMatrix/releases)
+[![Python 3.11+](https://img.shields.io/badge/python-3.11%2B-3776AB?logo=python&logoColor=white)](https://www.python.org/)
+[![License: Apache-2.0](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+
+EvidenceMatrix builds deterministic coverage matrices for a declared set of entities and expected sources. It shows which relationships are supported, have known gaps, are unavailable, remain unknown, or do not apply.
+
+EvidenceMatrix was extracted from source-coverage auditing patterns developed in a real-world multi-source data pipeline. It is a standalone tool and does not require that project or its data.
+
+## What it does
+
+- Validates a small YAML or JSON manifest of entities, sources, and coverage declarations.
+- Expands the declared entities and sources into a complete, sorted entity-by-source matrix.
+- Reports status counts and unresolved relationships without assigning a subjective quality score.
+- Writes stable CSV, JSON, and Markdown reports without adding timestamps.
+- Runs locally and offline after installation.
+
+## What it does not do
+
+EvidenceMatrix does not download or transform data, validate arbitrary dataset schemas, verify file integrity, build lineage graphs, align spatial data, manage workflows, or evaluate machine-learning models. Use [LineageGuard](https://github.com/KageRyo/LineageGuard) for artifact origin and lineage, [ReleaseGuard](https://github.com/KageRyo/ReleaseGuard) for dataset release structure and integrity, and [GridForge](https://github.com/KageRyo/GridForge) for spatial alignment.
+
+## Installation
+
+After a release is published, install it with `uv tool install evidencematrix` or `python -m pip install evidencematrix`. To run from a checkout, use Python 3.11 or newer and `uv sync --all-groups`, then prefix commands with `uv run`.
+
+The runtime has one dependency, PyYAML, for safe YAML parsing. JSON input and all audit calculations work offline; the CLI makes no network requests.
+
+## Quick start
+
+The bundled [`examples/basic/coverage.yaml`](examples/basic/coverage.yaml) demonstrates supported, mapping-gap, metadata-gap, unavailable, not-in-release, not-applicable, and unknown relationships.
+
+```bash
+evidencematrix validate examples/basic
+evidencematrix build examples/basic --output ./out
+evidencematrix audit examples/basic
+evidencematrix summary examples/basic
+evidencematrix summary examples/basic --format json
+```
+
+`audit` returns exit code 1 for unresolved relationships in this example. The example contains gaps intentionally; `validate`, `build`, and `summary` succeed with exit code 0.
+
+`build` writes `coverage_matrix.csv`, `coverage_report.json`, `gap_report.json`, `summary.json`, and `coverage_report.md`. The JSON reports use sorted keys and stable indentation; CSV rows sort by entity ID and source ID. Rebuilding identical input with the same tool version produces byte-identical files.
+
+## Input model
+
+A manifest has `version`, `entities`, `sources`, and `coverage` fields. IDs are unique strings. Each source declares its availability. Coverage entries are optional and identify one entity, one source, and one status; `reason` is an optional explanatory string for non-supported states.
+
+```yaml
+version: 1
+
+entities:
+  - id: event-001
+  - id: event-002
+
+sources:
+  - id: cwa
+    availability: available
+  - id: emic
+    availability: unavailable
+
+coverage:
+  - entity: event-001
+    source: cwa
+    status: supported
+  - entity: event-002
+    source: cwa
+    status: mapping_gap
+    reason: no_verified_mapping
+```
+
+The input is deliberately strict: unknown fields, duplicate IDs or relationships, invalid references, duplicate YAML or JSON keys, and contradictory availability declarations fail validation. `PATH` may point to a `.yaml`, `.yml`, or `.json` file, or to a directory containing exactly one such manifest. No external file references are part of schema version 1.
+
+### Availability and coverage status
+
+Source availability and entity-source coverage describe related but separate facts. Availability accepts `available`, `unavailable`, `not_in_release`, and `unknown`. Coverage accepts:
+
+| Status | Meaning |
+| --- | --- |
+| `supported` | The manifest declares evidence for this entity-source relationship. |
+| `metadata_gap` | Required descriptive metadata is missing or unresolved. |
+| `mapping_gap` | The source-to-entity relationship is not established. |
+| `source_unavailable` | The source payload is declared unavailable. |
+| `source_not_in_release` | The expected source is not included in the release being described. |
+| `not_applicable` | The relationship is explicitly outside scope. |
+| `unknown` | The relationship has not been assessed. |
+
+Each entity is paired with every listed source. An explicit coverage row sets that pair's status. If no row exists, a source marked `unavailable` or `not_in_release` determines the corresponding relationship status; otherwise the relationship remains `unknown`. In particular, a missing relationship is never inferred to be a mapping gap. Explicit `not_applicable` relationships stay visible in the matrix and summary, but are excluded from unresolved audit findings.
+
+`supported` is a manifest declaration. EvidenceMatrix checks that declaration's structure and consistency; it does not inspect or authenticate external evidence.
+
+## Commands and exit codes
+
+```text
+evidencematrix validate PATH
+evidencematrix build PATH [--output DIR]
+evidencematrix audit PATH [--format text|json]
+evidencematrix summary PATH [--format text|json]
+```
+
+`validate` checks input without modifying it. `build` creates deterministic reports. `audit` lists unresolved rows and returns 1 when it finds any; `not_applicable` rows are reported separately and do not fail the audit. `summary` prints counts, including all status categories, and supports machine-readable JSON. Commands are noninteractive; diagnostics go to stderr.
+
+Exit codes are 0 for a valid command with no blocking finding, 1 for unresolved audit findings, and 2 for invalid input or execution errors.
+
+## Development
+
+```bash
+uv sync --all-groups
+uv run ruff check .
+uv run ruff format --check .
+uv run pytest
+uv build
+```
+
+GitHub Actions runs lint and format checks, tests, package builds, and CLI smoke checks on Python 3.11, 3.12, and 3.13.
+
+## Real-dataset dogfood
+
+The public [TWDisaster dataset](https://github.com/KageRyo/TWDisaster) publishes positive event-source links but no expected-source eligibility matrix. The [dogfood assessment](examples/twdisaster/README.md) explains why converting absent links into gaps would invent facts and why the current release cannot provide a useful matrix of expected coverage.
+
+## License
+
+EvidenceMatrix is distributed under the [Apache License 2.0](LICENSE).

evidencematrix-0.1.0.dist-info/RECORD

@@ -0,0 +1,14 @@
+evidencematrix/__init__.py,sha256=AtnYsp46AK_xxwEE_1CsgwYnRz5N3cSiCJpSvstBdWo,526
+evidencematrix/audit.py,sha256=wTASHvp8nXASwl7YApZAIvG-QjuaLbFs-sIunskJYik,775
+evidencematrix/cli.py,sha256=GsVvT4f5odDZXsItW1GPB6Job23rkkCHU-aOh4sb4ps,3642
+evidencematrix/matrix.py,sha256=nHv-6WyF_e-dFlbhRz8wLfNthdKA3yjdMVprsqhFyDM,2298
+evidencematrix/model.py,sha256=4w1eSBvIMWCaWjRkFnkjVNyGKzOIYbqje_NyrlaP1-k,1942
+evidencematrix/output.py,sha256=HcgcJBs0L2UNXdAwgG_1X6eh_xzME8RTtlCJ65XZyR8,5163
+evidencematrix/parser.py,sha256=T9JYTXrUu5cOjsKAvIV_f9hUDhjpIbl3TQr7NK7i1AY,3228
+evidencematrix/validation.py,sha256=ooyYNPSc6ZblnAN2QVx6JYeWVg7koJ8L24s3C_K4SKg,8293
+evidencematrix-0.1.0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+evidencematrix-0.1.0.dist-info/METADATA,sha256=5KFZOJ936RugsYqwrILBrPiLybbP00EvXUnivrYE-VM,8175
+evidencematrix-0.1.0.dist-info/WHEEL,sha256=YVMoNqKzERt-wjUZwJ33xBGAwnFl-4cqbYkTtWa4itE,91
+evidencematrix-0.1.0.dist-info/entry_points.txt,sha256=jHtrqg-Wv-iTrtDE0spqv0UQtHD_p0pRdVNYBQCxCTo,65
+evidencematrix-0.1.0.dist-info/top_level.txt,sha256=cbjEpzTqsS6tvMw0KyFA-O9j9FyRLqhPwZpKTwM3t6U,15
+evidencematrix-0.1.0.dist-info/RECORD,,

evidencematrix-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (84.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

evidencematrix-0.1.0.dist-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+evidencematrix = evidencematrix.cli:entrypoint

evidencematrix-0.1.0.dist-info/licenses/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.

evidencematrix-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+evidencematrix