evidencematrix 0.1.0__tar.gz
This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
- evidencematrix-0.1.0/LICENSE +201 -0
- evidencematrix-0.1.0/MANIFEST.in +2 -0
- evidencematrix-0.1.0/PKG-INFO +150 -0
- evidencematrix-0.1.0/README.md +125 -0
- evidencematrix-0.1.0/examples/basic/coverage.yaml +33 -0
- evidencematrix-0.1.0/examples/twdisaster/README.md +9 -0
- evidencematrix-0.1.0/pyproject.toml +53 -0
- evidencematrix-0.1.0/setup.cfg +4 -0
- evidencematrix-0.1.0/src/evidencematrix/__init__.py +18 -0
- evidencematrix-0.1.0/src/evidencematrix/audit.py +25 -0
- evidencematrix-0.1.0/src/evidencematrix/cli.py +101 -0
- evidencematrix-0.1.0/src/evidencematrix/matrix.py +60 -0
- evidencematrix-0.1.0/src/evidencematrix/model.py +88 -0
- evidencematrix-0.1.0/src/evidencematrix/output.py +152 -0
- evidencematrix-0.1.0/src/evidencematrix/parser.py +88 -0
- evidencematrix-0.1.0/src/evidencematrix/validation.py +212 -0
- evidencematrix-0.1.0/src/evidencematrix.egg-info/PKG-INFO +150 -0
- evidencematrix-0.1.0/src/evidencematrix.egg-info/SOURCES.txt +24 -0
- evidencematrix-0.1.0/src/evidencematrix.egg-info/dependency_links.txt +1 -0
- evidencematrix-0.1.0/src/evidencematrix.egg-info/entry_points.txt +2 -0
- evidencematrix-0.1.0/src/evidencematrix.egg-info/requires.txt +1 -0
- evidencematrix-0.1.0/src/evidencematrix.egg-info/top_level.txt +1 -0
- evidencematrix-0.1.0/tests/test_cli.py +82 -0
- evidencematrix-0.1.0/tests/test_manifest.py +190 -0
- evidencematrix-0.1.0/tests/test_matrix.py +102 -0
- evidencematrix-0.1.0/tests/test_outputs.py +84 -0
|
@@ -0,0 +1,201 @@
|
|
|
1
|
+
Apache License
|
|
2
|
+
Version 2.0, January 2004
|
|
3
|
+
http://www.apache.org/licenses/
|
|
4
|
+
|
|
5
|
+
TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
|
|
6
|
+
|
|
7
|
+
1. Definitions.
|
|
8
|
+
|
|
9
|
+
"License" shall mean the terms and conditions for use, reproduction,
|
|
10
|
+
and distribution as defined by Sections 1 through 9 of this document.
|
|
11
|
+
|
|
12
|
+
"Licensor" shall mean the copyright owner or entity authorized by
|
|
13
|
+
the copyright owner that is granting the License.
|
|
14
|
+
|
|
15
|
+
"Legal Entity" shall mean the union of the acting entity and all
|
|
16
|
+
other entities that control, are controlled by, or are under common
|
|
17
|
+
control with that entity. For the purposes of this definition,
|
|
18
|
+
"control" means (i) the power, direct or indirect, to cause the
|
|
19
|
+
direction or management of such entity, whether by contract or
|
|
20
|
+
otherwise, or (ii) ownership of fifty percent (50%) or more of the
|
|
21
|
+
outstanding shares, or (iii) beneficial ownership of such entity.
|
|
22
|
+
|
|
23
|
+
"You" (or "Your") shall mean an individual or Legal Entity
|
|
24
|
+
exercising permissions granted by this License.
|
|
25
|
+
|
|
26
|
+
"Source" form shall mean the preferred form for making modifications,
|
|
27
|
+
including but not limited to software source code, documentation
|
|
28
|
+
source, and configuration files.
|
|
29
|
+
|
|
30
|
+
"Object" form shall mean any form resulting from mechanical
|
|
31
|
+
transformation or translation of a Source form, including but
|
|
32
|
+
not limited to compiled object code, generated documentation,
|
|
33
|
+
and conversions to other media types.
|
|
34
|
+
|
|
35
|
+
"Work" shall mean the work of authorship, whether in Source or
|
|
36
|
+
Object form, made available under the License, as indicated by a
|
|
37
|
+
copyright notice that is included in or attached to the work
|
|
38
|
+
(an example is provided in the Appendix below).
|
|
39
|
+
|
|
40
|
+
"Derivative Works" shall mean any work, whether in Source or Object
|
|
41
|
+
form, that is based on (or derived from) the Work and for which the
|
|
42
|
+
editorial revisions, annotations, elaborations, or other modifications
|
|
43
|
+
represent, as a whole, an original work of authorship. For the purposes
|
|
44
|
+
of this License, Derivative Works shall not include works that remain
|
|
45
|
+
separable from, or merely link (or bind by name) to the interfaces of,
|
|
46
|
+
the Work and Derivative Works thereof.
|
|
47
|
+
|
|
48
|
+
"Contribution" shall mean any work of authorship, including
|
|
49
|
+
the original version of the Work and any modifications or additions
|
|
50
|
+
to that Work or Derivative Works thereof, that is intentionally
|
|
51
|
+
submitted to Licensor for inclusion in the Work by the copyright owner
|
|
52
|
+
or by an individual or Legal Entity authorized to submit on behalf of
|
|
53
|
+
the copyright owner. For the purposes of this definition, "submitted"
|
|
54
|
+
means any form of electronic, verbal, or written communication sent
|
|
55
|
+
to the Licensor or its representatives, including but not limited to
|
|
56
|
+
communication on electronic mailing lists, source code control systems,
|
|
57
|
+
and issue tracking systems that are managed by, or on behalf of, the
|
|
58
|
+
Licensor for the purpose of discussing and improving the Work, but
|
|
59
|
+
excluding communication that is conspicuously marked or otherwise
|
|
60
|
+
designated in writing by the copyright owner as "Not a Contribution."
|
|
61
|
+
|
|
62
|
+
"Contributor" shall mean Licensor and any individual or Legal Entity
|
|
63
|
+
on behalf of whom a Contribution has been received by Licensor and
|
|
64
|
+
subsequently incorporated within the Work.
|
|
65
|
+
|
|
66
|
+
2. Grant of Copyright License. Subject to the terms and conditions of
|
|
67
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
68
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
69
|
+
copyright license to reproduce, prepare Derivative Works of,
|
|
70
|
+
publicly display, publicly perform, sublicense, and distribute the
|
|
71
|
+
Work and such Derivative Works in Source or Object form.
|
|
72
|
+
|
|
73
|
+
3. Grant of Patent License. Subject to the terms and conditions of
|
|
74
|
+
this License, each Contributor hereby grants to You a perpetual,
|
|
75
|
+
worldwide, non-exclusive, no-charge, royalty-free, irrevocable
|
|
76
|
+
(except as stated in this section) patent license to make, have made,
|
|
77
|
+
use, offer to sell, sell, import, and otherwise transfer the Work,
|
|
78
|
+
where such license applies only to those patent claims licensable
|
|
79
|
+
by such Contributor that are necessarily infringed by their
|
|
80
|
+
Contribution(s) alone or by combination of their Contribution(s)
|
|
81
|
+
with the Work to which such Contribution(s) was submitted. If You
|
|
82
|
+
institute patent litigation against any entity (including a
|
|
83
|
+
cross-claim or counterclaim in a lawsuit) alleging that the Work
|
|
84
|
+
or a Contribution incorporated within the Work constitutes direct
|
|
85
|
+
or contributory patent infringement, then any patent licenses
|
|
86
|
+
granted to You under this License for that Work shall terminate
|
|
87
|
+
as of the date such litigation is filed.
|
|
88
|
+
|
|
89
|
+
4. Redistribution. You may reproduce and distribute copies of the
|
|
90
|
+
Work or Derivative Works thereof in any medium, with or without
|
|
91
|
+
modifications, and in Source or Object form, provided that You
|
|
92
|
+
meet the following conditions:
|
|
93
|
+
|
|
94
|
+
(a) You must give any other recipients of the Work or
|
|
95
|
+
Derivative Works a copy of this License; and
|
|
96
|
+
|
|
97
|
+
(b) You must cause any modified files to carry prominent notices
|
|
98
|
+
stating that You changed the files; and
|
|
99
|
+
|
|
100
|
+
(c) You must retain, in the Source form of any Derivative Works
|
|
101
|
+
that You distribute, all copyright, patent, trademark, and
|
|
102
|
+
attribution notices from the Source form of the Work,
|
|
103
|
+
excluding those notices that do not pertain to any part of
|
|
104
|
+
the Derivative Works; and
|
|
105
|
+
|
|
106
|
+
(d) If the Work includes a "NOTICE" text file as part of its
|
|
107
|
+
distribution, then any Derivative Works that You distribute must
|
|
108
|
+
include a readable copy of the attribution notices contained
|
|
109
|
+
within such NOTICE file, excluding those notices that do not
|
|
110
|
+
pertain to any part of the Derivative Works, in at least one
|
|
111
|
+
of the following places: within a NOTICE text file distributed
|
|
112
|
+
as part of the Derivative Works; within the Source form or
|
|
113
|
+
documentation, if provided along with the Derivative Works; or,
|
|
114
|
+
within a display generated by the Derivative Works, if and
|
|
115
|
+
wherever such third-party notices normally appear. The contents
|
|
116
|
+
of the NOTICE file are for informational purposes only and
|
|
117
|
+
do not modify the License. You may add Your own attribution
|
|
118
|
+
notices within Derivative Works that You distribute, alongside
|
|
119
|
+
or as an addendum to the NOTICE text from the Work, provided
|
|
120
|
+
that such additional attribution notices cannot be construed
|
|
121
|
+
as modifying the License.
|
|
122
|
+
|
|
123
|
+
You may add Your own copyright statement to Your modifications and
|
|
124
|
+
may provide additional or different license terms and conditions
|
|
125
|
+
for use, reproduction, or distribution of Your modifications, or
|
|
126
|
+
for any such Derivative Works as a whole, provided Your use,
|
|
127
|
+
reproduction, and distribution of the Work otherwise complies with
|
|
128
|
+
the conditions stated in this License.
|
|
129
|
+
|
|
130
|
+
5. Submission of Contributions. Unless You explicitly state otherwise,
|
|
131
|
+
any Contribution intentionally submitted for inclusion in the Work
|
|
132
|
+
by You to the Licensor shall be under the terms and conditions of
|
|
133
|
+
this License, without any additional terms or conditions.
|
|
134
|
+
Notwithstanding the above, nothing herein shall supersede or modify
|
|
135
|
+
the terms of any separate license agreement you may have executed
|
|
136
|
+
with Licensor regarding such Contributions.
|
|
137
|
+
|
|
138
|
+
6. Trademarks. This License does not grant permission to use the trade
|
|
139
|
+
names, trademarks, service marks, or product names of the Licensor,
|
|
140
|
+
except as required for reasonable and customary use in describing the
|
|
141
|
+
origin of the Work and reproducing the content of the NOTICE file.
|
|
142
|
+
|
|
143
|
+
7. Disclaimer of Warranty. Unless required by applicable law or
|
|
144
|
+
agreed to in writing, Licensor provides the Work (and each
|
|
145
|
+
Contributor provides its Contributions) on an "AS IS" BASIS,
|
|
146
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
|
|
147
|
+
implied, including, without limitation, any warranties or conditions
|
|
148
|
+
of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
|
|
149
|
+
PARTICULAR PURPOSE. You are solely responsible for determining the
|
|
150
|
+
appropriateness of using or redistributing the Work and assume any
|
|
151
|
+
risks associated with Your exercise of permissions under this License.
|
|
152
|
+
|
|
153
|
+
8. Limitation of Liability. In no event and under no legal theory,
|
|
154
|
+
whether in tort (including negligence), contract, or otherwise,
|
|
155
|
+
unless required by applicable law (such as deliberate and grossly
|
|
156
|
+
negligent acts) or agreed to in writing, shall any Contributor be
|
|
157
|
+
liable to You for damages, including any direct, indirect, special,
|
|
158
|
+
incidental, or consequential damages of any character arising as a
|
|
159
|
+
result of this License or out of the use or inability to use the
|
|
160
|
+
Work (including but not limited to damages for loss of goodwill,
|
|
161
|
+
work stoppage, computer failure or malfunction, or any and all
|
|
162
|
+
other commercial damages or losses), even if such Contributor
|
|
163
|
+
has been advised of the possibility of such damages.
|
|
164
|
+
|
|
165
|
+
9. Accepting Warranty or Additional Liability. While redistributing
|
|
166
|
+
the Work or Derivative Works thereof, You may choose to offer,
|
|
167
|
+
and charge a fee for, acceptance of support, warranty, indemnity,
|
|
168
|
+
or other liability obligations and/or rights consistent with this
|
|
169
|
+
License. However, in accepting such obligations, You may act only
|
|
170
|
+
on Your own behalf and on Your sole responsibility, not on behalf
|
|
171
|
+
of any other Contributor, and only if You agree to indemnify,
|
|
172
|
+
defend, and hold each Contributor harmless for any liability
|
|
173
|
+
incurred by, or claims asserted against, such Contributor by reason
|
|
174
|
+
of your accepting any such warranty or additional liability.
|
|
175
|
+
|
|
176
|
+
END OF TERMS AND CONDITIONS
|
|
177
|
+
|
|
178
|
+
APPENDIX: How to apply the Apache License to your work.
|
|
179
|
+
|
|
180
|
+
To apply the Apache License to your work, attach the following
|
|
181
|
+
boilerplate notice, with the fields enclosed by brackets "[]"
|
|
182
|
+
replaced with your own identifying information. (Don't include
|
|
183
|
+
the brackets!) The text should be enclosed in the appropriate
|
|
184
|
+
comment syntax for the file format. We also recommend that a
|
|
185
|
+
file or class name and description of purpose be included on the
|
|
186
|
+
same "printed page" as the copyright notice for easier
|
|
187
|
+
identification within third-party archives.
|
|
188
|
+
|
|
189
|
+
Copyright [yyyy] [name of copyright owner]
|
|
190
|
+
|
|
191
|
+
Licensed under the Apache License, Version 2.0 (the "License");
|
|
192
|
+
you may not use this file except in compliance with the License.
|
|
193
|
+
You may obtain a copy of the License at
|
|
194
|
+
|
|
195
|
+
http://www.apache.org/licenses/LICENSE-2.0
|
|
196
|
+
|
|
197
|
+
Unless required by applicable law or agreed to in writing, software
|
|
198
|
+
distributed under the License is distributed on an "AS IS" BASIS,
|
|
199
|
+
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
|
200
|
+
See the License for the specific language governing permissions and
|
|
201
|
+
limitations under the License.
|
|
@@ -0,0 +1,150 @@
|
|
|
1
|
+
Metadata-Version: 2.4
|
|
2
|
+
Name: evidencematrix
|
|
3
|
+
Version: 0.1.0
|
|
4
|
+
Summary: A deterministic source-coverage audit tool for multi-source datasets
|
|
5
|
+
Author: KageRyo
|
|
6
|
+
License-Expression: Apache-2.0
|
|
7
|
+
Project-URL: Homepage, https://github.com/KageRyo/EvidenceMatrix
|
|
8
|
+
Project-URL: Repository, https://github.com/KageRyo/EvidenceMatrix
|
|
9
|
+
Project-URL: Issues, https://github.com/KageRyo/EvidenceMatrix/issues
|
|
10
|
+
Classifier: Development Status :: 3 - Alpha
|
|
11
|
+
Classifier: Environment :: Console
|
|
12
|
+
Classifier: Intended Audience :: Developers
|
|
13
|
+
Classifier: Operating System :: OS Independent
|
|
14
|
+
Classifier: Programming Language :: Python :: 3
|
|
15
|
+
Classifier: Programming Language :: Python :: 3.11
|
|
16
|
+
Classifier: Programming Language :: Python :: 3.12
|
|
17
|
+
Classifier: Programming Language :: Python :: 3.13
|
|
18
|
+
Classifier: Topic :: Database
|
|
19
|
+
Classifier: Topic :: Scientific/Engineering :: Information Analysis
|
|
20
|
+
Requires-Python: >=3.11
|
|
21
|
+
Description-Content-Type: text/markdown
|
|
22
|
+
License-File: LICENSE
|
|
23
|
+
Requires-Dist: PyYAML<7,>=6.0
|
|
24
|
+
Dynamic: license-file
|
|
25
|
+
|
|
26
|
+
# EvidenceMatrix
|
|
27
|
+
|
|
28
|
+
[](https://github.com/KageRyo/EvidenceMatrix/actions/workflows/ci.yml)
|
|
29
|
+
[](https://pypi.org/project/evidencematrix/)
|
|
30
|
+
[](https://github.com/KageRyo/EvidenceMatrix/releases)
|
|
31
|
+
[](https://www.python.org/)
|
|
32
|
+
[](LICENSE)
|
|
33
|
+
|
|
34
|
+
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.
|
|
35
|
+
|
|
36
|
+
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.
|
|
37
|
+
|
|
38
|
+
## What it does
|
|
39
|
+
|
|
40
|
+
- Validates a small YAML or JSON manifest of entities, sources, and coverage declarations.
|
|
41
|
+
- Expands the declared entities and sources into a complete, sorted entity-by-source matrix.
|
|
42
|
+
- Reports status counts and unresolved relationships without assigning a subjective quality score.
|
|
43
|
+
- Writes stable CSV, JSON, and Markdown reports without adding timestamps.
|
|
44
|
+
- Runs locally and offline after installation.
|
|
45
|
+
|
|
46
|
+
## What it does not do
|
|
47
|
+
|
|
48
|
+
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.
|
|
49
|
+
|
|
50
|
+
## Installation
|
|
51
|
+
|
|
52
|
+
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`.
|
|
53
|
+
|
|
54
|
+
The runtime has one dependency, PyYAML, for safe YAML parsing. JSON input and all audit calculations work offline; the CLI makes no network requests.
|
|
55
|
+
|
|
56
|
+
## Quick start
|
|
57
|
+
|
|
58
|
+
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.
|
|
59
|
+
|
|
60
|
+
```bash
|
|
61
|
+
evidencematrix validate examples/basic
|
|
62
|
+
evidencematrix build examples/basic --output ./out
|
|
63
|
+
evidencematrix audit examples/basic
|
|
64
|
+
evidencematrix summary examples/basic
|
|
65
|
+
evidencematrix summary examples/basic --format json
|
|
66
|
+
```
|
|
67
|
+
|
|
68
|
+
`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.
|
|
69
|
+
|
|
70
|
+
`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.
|
|
71
|
+
|
|
72
|
+
## Input model
|
|
73
|
+
|
|
74
|
+
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.
|
|
75
|
+
|
|
76
|
+
```yaml
|
|
77
|
+
version: 1
|
|
78
|
+
|
|
79
|
+
entities:
|
|
80
|
+
- id: event-001
|
|
81
|
+
- id: event-002
|
|
82
|
+
|
|
83
|
+
sources:
|
|
84
|
+
- id: cwa
|
|
85
|
+
availability: available
|
|
86
|
+
- id: emic
|
|
87
|
+
availability: unavailable
|
|
88
|
+
|
|
89
|
+
coverage:
|
|
90
|
+
- entity: event-001
|
|
91
|
+
source: cwa
|
|
92
|
+
status: supported
|
|
93
|
+
- entity: event-002
|
|
94
|
+
source: cwa
|
|
95
|
+
status: mapping_gap
|
|
96
|
+
reason: no_verified_mapping
|
|
97
|
+
```
|
|
98
|
+
|
|
99
|
+
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.
|
|
100
|
+
|
|
101
|
+
### Availability and coverage status
|
|
102
|
+
|
|
103
|
+
Source availability and entity-source coverage describe related but separate facts. Availability accepts `available`, `unavailable`, `not_in_release`, and `unknown`. Coverage accepts:
|
|
104
|
+
|
|
105
|
+
| Status | Meaning |
|
|
106
|
+
| --- | --- |
|
|
107
|
+
| `supported` | The manifest declares evidence for this entity-source relationship. |
|
|
108
|
+
| `metadata_gap` | Required descriptive metadata is missing or unresolved. |
|
|
109
|
+
| `mapping_gap` | The source-to-entity relationship is not established. |
|
|
110
|
+
| `source_unavailable` | The source payload is declared unavailable. |
|
|
111
|
+
| `source_not_in_release` | The expected source is not included in the release being described. |
|
|
112
|
+
| `not_applicable` | The relationship is explicitly outside scope. |
|
|
113
|
+
| `unknown` | The relationship has not been assessed. |
|
|
114
|
+
|
|
115
|
+
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.
|
|
116
|
+
|
|
117
|
+
`supported` is a manifest declaration. EvidenceMatrix checks that declaration's structure and consistency; it does not inspect or authenticate external evidence.
|
|
118
|
+
|
|
119
|
+
## Commands and exit codes
|
|
120
|
+
|
|
121
|
+
```text
|
|
122
|
+
evidencematrix validate PATH
|
|
123
|
+
evidencematrix build PATH [--output DIR]
|
|
124
|
+
evidencematrix audit PATH [--format text|json]
|
|
125
|
+
evidencematrix summary PATH [--format text|json]
|
|
126
|
+
```
|
|
127
|
+
|
|
128
|
+
`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.
|
|
129
|
+
|
|
130
|
+
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.
|
|
131
|
+
|
|
132
|
+
## Development
|
|
133
|
+
|
|
134
|
+
```bash
|
|
135
|
+
uv sync --all-groups
|
|
136
|
+
uv run ruff check .
|
|
137
|
+
uv run ruff format --check .
|
|
138
|
+
uv run pytest
|
|
139
|
+
uv build
|
|
140
|
+
```
|
|
141
|
+
|
|
142
|
+
GitHub Actions runs lint and format checks, tests, package builds, and CLI smoke checks on Python 3.11, 3.12, and 3.13.
|
|
143
|
+
|
|
144
|
+
## Real-dataset dogfood
|
|
145
|
+
|
|
146
|
+
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.
|
|
147
|
+
|
|
148
|
+
## License
|
|
149
|
+
|
|
150
|
+
EvidenceMatrix is distributed under the [Apache License 2.0](LICENSE).
|
|
@@ -0,0 +1,125 @@
|
|
|
1
|
+
# EvidenceMatrix
|
|
2
|
+
|
|
3
|
+
[](https://github.com/KageRyo/EvidenceMatrix/actions/workflows/ci.yml)
|
|
4
|
+
[](https://pypi.org/project/evidencematrix/)
|
|
5
|
+
[](https://github.com/KageRyo/EvidenceMatrix/releases)
|
|
6
|
+
[](https://www.python.org/)
|
|
7
|
+
[](LICENSE)
|
|
8
|
+
|
|
9
|
+
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.
|
|
10
|
+
|
|
11
|
+
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.
|
|
12
|
+
|
|
13
|
+
## What it does
|
|
14
|
+
|
|
15
|
+
- Validates a small YAML or JSON manifest of entities, sources, and coverage declarations.
|
|
16
|
+
- Expands the declared entities and sources into a complete, sorted entity-by-source matrix.
|
|
17
|
+
- Reports status counts and unresolved relationships without assigning a subjective quality score.
|
|
18
|
+
- Writes stable CSV, JSON, and Markdown reports without adding timestamps.
|
|
19
|
+
- Runs locally and offline after installation.
|
|
20
|
+
|
|
21
|
+
## What it does not do
|
|
22
|
+
|
|
23
|
+
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.
|
|
24
|
+
|
|
25
|
+
## Installation
|
|
26
|
+
|
|
27
|
+
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`.
|
|
28
|
+
|
|
29
|
+
The runtime has one dependency, PyYAML, for safe YAML parsing. JSON input and all audit calculations work offline; the CLI makes no network requests.
|
|
30
|
+
|
|
31
|
+
## Quick start
|
|
32
|
+
|
|
33
|
+
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.
|
|
34
|
+
|
|
35
|
+
```bash
|
|
36
|
+
evidencematrix validate examples/basic
|
|
37
|
+
evidencematrix build examples/basic --output ./out
|
|
38
|
+
evidencematrix audit examples/basic
|
|
39
|
+
evidencematrix summary examples/basic
|
|
40
|
+
evidencematrix summary examples/basic --format json
|
|
41
|
+
```
|
|
42
|
+
|
|
43
|
+
`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.
|
|
44
|
+
|
|
45
|
+
`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.
|
|
46
|
+
|
|
47
|
+
## Input model
|
|
48
|
+
|
|
49
|
+
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.
|
|
50
|
+
|
|
51
|
+
```yaml
|
|
52
|
+
version: 1
|
|
53
|
+
|
|
54
|
+
entities:
|
|
55
|
+
- id: event-001
|
|
56
|
+
- id: event-002
|
|
57
|
+
|
|
58
|
+
sources:
|
|
59
|
+
- id: cwa
|
|
60
|
+
availability: available
|
|
61
|
+
- id: emic
|
|
62
|
+
availability: unavailable
|
|
63
|
+
|
|
64
|
+
coverage:
|
|
65
|
+
- entity: event-001
|
|
66
|
+
source: cwa
|
|
67
|
+
status: supported
|
|
68
|
+
- entity: event-002
|
|
69
|
+
source: cwa
|
|
70
|
+
status: mapping_gap
|
|
71
|
+
reason: no_verified_mapping
|
|
72
|
+
```
|
|
73
|
+
|
|
74
|
+
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.
|
|
75
|
+
|
|
76
|
+
### Availability and coverage status
|
|
77
|
+
|
|
78
|
+
Source availability and entity-source coverage describe related but separate facts. Availability accepts `available`, `unavailable`, `not_in_release`, and `unknown`. Coverage accepts:
|
|
79
|
+
|
|
80
|
+
| Status | Meaning |
|
|
81
|
+
| --- | --- |
|
|
82
|
+
| `supported` | The manifest declares evidence for this entity-source relationship. |
|
|
83
|
+
| `metadata_gap` | Required descriptive metadata is missing or unresolved. |
|
|
84
|
+
| `mapping_gap` | The source-to-entity relationship is not established. |
|
|
85
|
+
| `source_unavailable` | The source payload is declared unavailable. |
|
|
86
|
+
| `source_not_in_release` | The expected source is not included in the release being described. |
|
|
87
|
+
| `not_applicable` | The relationship is explicitly outside scope. |
|
|
88
|
+
| `unknown` | The relationship has not been assessed. |
|
|
89
|
+
|
|
90
|
+
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.
|
|
91
|
+
|
|
92
|
+
`supported` is a manifest declaration. EvidenceMatrix checks that declaration's structure and consistency; it does not inspect or authenticate external evidence.
|
|
93
|
+
|
|
94
|
+
## Commands and exit codes
|
|
95
|
+
|
|
96
|
+
```text
|
|
97
|
+
evidencematrix validate PATH
|
|
98
|
+
evidencematrix build PATH [--output DIR]
|
|
99
|
+
evidencematrix audit PATH [--format text|json]
|
|
100
|
+
evidencematrix summary PATH [--format text|json]
|
|
101
|
+
```
|
|
102
|
+
|
|
103
|
+
`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.
|
|
104
|
+
|
|
105
|
+
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.
|
|
106
|
+
|
|
107
|
+
## Development
|
|
108
|
+
|
|
109
|
+
```bash
|
|
110
|
+
uv sync --all-groups
|
|
111
|
+
uv run ruff check .
|
|
112
|
+
uv run ruff format --check .
|
|
113
|
+
uv run pytest
|
|
114
|
+
uv build
|
|
115
|
+
```
|
|
116
|
+
|
|
117
|
+
GitHub Actions runs lint and format checks, tests, package builds, and CLI smoke checks on Python 3.11, 3.12, and 3.13.
|
|
118
|
+
|
|
119
|
+
## Real-dataset dogfood
|
|
120
|
+
|
|
121
|
+
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.
|
|
122
|
+
|
|
123
|
+
## License
|
|
124
|
+
|
|
125
|
+
EvidenceMatrix is distributed under the [Apache License 2.0](LICENSE).
|
|
@@ -0,0 +1,33 @@
|
|
|
1
|
+
version: 1
|
|
2
|
+
|
|
3
|
+
entities:
|
|
4
|
+
- id: incident-001
|
|
5
|
+
- id: incident-002
|
|
6
|
+
- id: incident-003
|
|
7
|
+
|
|
8
|
+
sources:
|
|
9
|
+
- id: public-registry
|
|
10
|
+
availability: available
|
|
11
|
+
- id: road-condition-feed
|
|
12
|
+
availability: unavailable
|
|
13
|
+
- id: shelter-directory
|
|
14
|
+
availability: unknown
|
|
15
|
+
- id: rainfall-archive
|
|
16
|
+
availability: not_in_release
|
|
17
|
+
|
|
18
|
+
coverage:
|
|
19
|
+
- entity: incident-001
|
|
20
|
+
source: public-registry
|
|
21
|
+
status: supported
|
|
22
|
+
- entity: incident-002
|
|
23
|
+
source: public-registry
|
|
24
|
+
status: mapping_gap
|
|
25
|
+
reason: no_verified_entity_mapping
|
|
26
|
+
- entity: incident-003
|
|
27
|
+
source: public-registry
|
|
28
|
+
status: metadata_gap
|
|
29
|
+
reason: source_record_has_no_publication_date
|
|
30
|
+
- entity: incident-001
|
|
31
|
+
source: shelter-directory
|
|
32
|
+
status: not_applicable
|
|
33
|
+
reason: this_example_entity_is_outside_the_directory_scope
|
|
@@ -0,0 +1,9 @@
|
|
|
1
|
+
# TWDisaster dogfood assessment
|
|
2
|
+
|
|
3
|
+
TWDisaster publishes event identities, source records, and explicit positive event-source links in [`data/events.csv`](https://github.com/KageRyo/TWDisaster/blob/main/data/events.csv), [`data/sources.csv`](https://github.com/KageRyo/TWDisaster/blob/main/data/sources.csv), and [`data/event_sources.csv`](https://github.com/KageRyo/TWDisaster/blob/main/data/event_sources.csv). Its data model defines an event-source row as a source supporting at least one included observation for that event.
|
|
4
|
+
|
|
5
|
+
Those files do not define which sources are expected for each event. Treating every absent event-source row as `mapping_gap`, `source_unavailable`, or `not_applicable` would invent coverage facts; listing every source for every event would also imply an unsupported expected relationship. A sparse EvidenceMatrix manifest can preserve observed links as `supported`, but the remaining full matrix would only say `unknown` and would not answer a useful missing-coverage question.
|
|
6
|
+
|
|
7
|
+
For v0.1, this dataset does not provide enough information for a meaningful coverage audit without adding unsupported expectations. No TWDisaster rows are copied into this project. A future release that declares expected source eligibility per event can be represented directly as an ordinary EvidenceMatrix manifest.
|
|
8
|
+
|
|
9
|
+
See the [TWDisaster data model](https://github.com/KageRyo/TWDisaster/blob/main/docs/data-model.md) for the published relationship semantics.
|
|
@@ -0,0 +1,53 @@
|
|
|
1
|
+
[build-system]
|
|
2
|
+
requires = ["setuptools>=77", "wheel"]
|
|
3
|
+
build-backend = "setuptools.build_meta"
|
|
4
|
+
|
|
5
|
+
[project]
|
|
6
|
+
name = "evidencematrix"
|
|
7
|
+
version = "0.1.0"
|
|
8
|
+
description = "A deterministic source-coverage audit tool for multi-source datasets"
|
|
9
|
+
readme = "README.md"
|
|
10
|
+
requires-python = ">=3.11"
|
|
11
|
+
license = "Apache-2.0"
|
|
12
|
+
authors = [{ name = "KageRyo" }]
|
|
13
|
+
classifiers = [
|
|
14
|
+
"Development Status :: 3 - Alpha",
|
|
15
|
+
"Environment :: Console",
|
|
16
|
+
"Intended Audience :: Developers",
|
|
17
|
+
"Operating System :: OS Independent",
|
|
18
|
+
"Programming Language :: Python :: 3",
|
|
19
|
+
"Programming Language :: Python :: 3.11",
|
|
20
|
+
"Programming Language :: Python :: 3.12",
|
|
21
|
+
"Programming Language :: Python :: 3.13",
|
|
22
|
+
"Topic :: Database",
|
|
23
|
+
"Topic :: Scientific/Engineering :: Information Analysis",
|
|
24
|
+
]
|
|
25
|
+
dependencies = ["PyYAML>=6.0,<7"]
|
|
26
|
+
|
|
27
|
+
[project.urls]
|
|
28
|
+
Homepage = "https://github.com/KageRyo/EvidenceMatrix"
|
|
29
|
+
Repository = "https://github.com/KageRyo/EvidenceMatrix"
|
|
30
|
+
Issues = "https://github.com/KageRyo/EvidenceMatrix/issues"
|
|
31
|
+
|
|
32
|
+
[project.scripts]
|
|
33
|
+
evidencematrix = "evidencematrix.cli:entrypoint"
|
|
34
|
+
|
|
35
|
+
[dependency-groups]
|
|
36
|
+
dev = ["build>=1.2", "pytest>=8.0", "ruff>=0.11"]
|
|
37
|
+
|
|
38
|
+
[tool.setuptools]
|
|
39
|
+
package-dir = { "" = "src" }
|
|
40
|
+
|
|
41
|
+
[tool.setuptools.packages.find]
|
|
42
|
+
where = ["src"]
|
|
43
|
+
|
|
44
|
+
[tool.pytest.ini_options]
|
|
45
|
+
testpaths = ["tests"]
|
|
46
|
+
addopts = "-ra"
|
|
47
|
+
|
|
48
|
+
[tool.ruff]
|
|
49
|
+
target-version = "py311"
|
|
50
|
+
line-length = 100
|
|
51
|
+
|
|
52
|
+
[tool.ruff.lint]
|
|
53
|
+
select = ["E", "F", "I", "UP", "B"]
|
|
@@ -0,0 +1,18 @@
|
|
|
1
|
+
"""A deterministic source-coverage audit tool for multi-source datasets."""
|
|
2
|
+
|
|
3
|
+
from evidencematrix.matrix import build_matrix, summarize_matrix
|
|
4
|
+
from evidencematrix.model import CoverageStatus, SourceAvailability
|
|
5
|
+
from evidencematrix.parser import load_manifest
|
|
6
|
+
from evidencematrix.validation import ManifestError, validate_document
|
|
7
|
+
|
|
8
|
+
__all__ = [
|
|
9
|
+
"CoverageStatus",
|
|
10
|
+
"ManifestError",
|
|
11
|
+
"SourceAvailability",
|
|
12
|
+
"build_matrix",
|
|
13
|
+
"load_manifest",
|
|
14
|
+
"summarize_matrix",
|
|
15
|
+
"validate_document",
|
|
16
|
+
]
|
|
17
|
+
|
|
18
|
+
__version__ = "0.1.0"
|
|
@@ -0,0 +1,25 @@
|
|
|
1
|
+
"""Coverage finding selection without subjective scoring."""
|
|
2
|
+
|
|
3
|
+
from __future__ import annotations
|
|
4
|
+
|
|
5
|
+
from evidencematrix.model import (
|
|
6
|
+
COVERAGE_STATUS_ORDER,
|
|
7
|
+
UNRESOLVED_STATUSES,
|
|
8
|
+
AuditReport,
|
|
9
|
+
CoverageRecord,
|
|
10
|
+
)
|
|
11
|
+
|
|
12
|
+
|
|
13
|
+
def audit_matrix(matrix: tuple[CoverageRecord, ...]) -> AuditReport:
|
|
14
|
+
"""Return unresolved relationships; supported and not-applicable rows are excluded."""
|
|
15
|
+
|
|
16
|
+
counts = {status.value: 0 for status in COVERAGE_STATUS_ORDER}
|
|
17
|
+
for record in matrix:
|
|
18
|
+
counts[record.status.value] += 1
|
|
19
|
+
findings = tuple(record for record in matrix if record.status in UNRESOLVED_STATUSES)
|
|
20
|
+
return AuditReport(
|
|
21
|
+
relationship_count=len(matrix),
|
|
22
|
+
status_counts=counts,
|
|
23
|
+
finding_count=len(findings),
|
|
24
|
+
findings=findings,
|
|
25
|
+
)
|