dq-agent 0.1.0__tar.gz

dq_agent-0.1.0/LICENSE

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

dq_agent-0.1.0/MANIFEST.in

@@ -0,0 +1 @@
+include build_backend.py

dq_agent-0.1.0/PKG-INFO

@@ -0,0 +1,499 @@
+Metadata-Version: 2.4
+Name: dq-agent
+Version: 0.1.0
+Summary: Data quality CLI demo with deterministic checks, anomaly detection, and replayable artifacts
+License-Expression: Apache-2.0
+Project-URL: Homepage, https://github.com/Tylor-Tian/dq_agent
+Project-URL: Issues, https://github.com/Tylor-Tian/dq_agent/issues
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas
+Requires-Dist: pyarrow
+Requires-Dist: pydantic
+Requires-Dist: pyyaml
+Requires-Dist: typer
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+# dq_agent
+
+[![CI](https://github.com/Tylor-Tian/dq_agent/actions/workflows/ci.yml/badge.svg)](https://github.com/Tylor-Tian/dq_agent/actions/workflows/ci.yml)
+![dq_agent demo](docs/assets/demo.svg)
+
+中文文档请见：[`README.zh-CN.md`](README.zh-CN.md)
+
+## What it is
+
+- A local/offline data quality CLI for CSV/Parquet inputs with YAML/JSON rules.
+- A deterministic runner that emits `report.json` (machine) and `report.md` (human).
+- A practical gate for CI quality checks using typed exit codes and artifacts.
+
+## What it isn't
+
+- Not a distributed compute engine.
+- Not an automatic data repair/correction system.
+- Not an LLM agent.
+
+## Installation
+
+Install from PyPI:
+
+```bash
+pip install dq-agent
+```
+
+Install with `pipx` (requires package to be published to PyPI first):
+
+```bash
+pipx install dq-agent
+```
+
+Install from source (repo usage):
+
+```bash
+pip install -e ".[test]"
+```
+
+## Demo in one command
+
+```bash
+dq demo
+```
+
+Use a custom output root:
+
+```bash
+dq demo --output-dir artifacts/demo_runs
+```
+
+Use Make targets for setup and demo:
+
+```bash
+make bootstrap
+make demo
+```
+
+## Quickstart (Demo)
+
+Requirements: **Python 3.11+**
+
+```bash
+python -m venv .venv
+source .venv/bin/activate
+python -m pip install -U pip
+pip install -e ".[test]"
+```
+
+Run the demo:
+
+```bash
+python -m dq_agent demo
+```
+
+Use idempotency keys to keep outputs stable across reruns:
+
+```bash
+python -m dq_agent demo --idempotency-key demo-001 --idempotency-mode reuse
+```
+
+It prints something like:
+
+```json
+{"report_json_path": "artifacts/<run_id>/report.json", "report_md_path": "artifacts/<run_id>/report.md", "run_record_path": "artifacts/<run_id>/run_record.json", "trace_path": "artifacts/<run_id>/trace.jsonl", "checkpoint_path": "artifacts/<run_id>/checkpoint.json"}
+```
+
+## CI Integration (GitHub Actions)
+
+Use `dq run` as a quality gate in CI:
+
+```yaml
+name: dq-gate
+on: [push, pull_request]
+jobs:
+  dq:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.11"
+      - name: Install
+        run: |
+          python -m pip install -U pip
+          pip install dq-agent
+          # For repository usage instead:
+          # pip install -e ".[test]"
+      - name: Run data quality gate
+        run: |
+          dq run --data path/to/data.parquet --config path/to/rules.yml --fail-on ERROR
+```
+
+Exit code semantics:
+- `0`: run completed and `--fail-on` was not triggered.
+- `1`: I/O/config errors.
+- `2`: guardrail/schema failures, idempotency conflict/regression, or `--fail-on` triggered.
+
+## Outputs
+
+A demo/run creates a new run directory:
+
+- `artifacts/<run_id>/report.json`
+- `artifacts/<run_id>/report.md`
+- `artifacts/<run_id>/run_record.json` (replayable run record)
+- `artifacts/<run_id>/trace.jsonl` (run trace events, NDJSON)
+- `artifacts/<run_id>/checkpoint.json` (resume checkpoint)
+
+`report.json` and `run_record.json` include `schema_version: 1` at the top level. `report.json` includes an
+`observability` section with timing and rule/anomaly counts.
+
+Sample outputs (committed for quick preview):
+
+- `examples/report.md`
+- `examples/report.json`
+
+> Note: `artifacts/` is ignored by git. Use `examples/` if you want committed sample reports.
+
+### Trace file
+
+Each run writes a minimal trace log to `trace.jsonl` (newline-delimited JSON). The trace includes `run_start`,
+`stage_start`, `stage_end`, and `run_end` events with elapsed milliseconds since start.
+
+Inspect it with standard shell tools:
+
+```bash
+tail -n +1 artifacts/<run_id>/trace.jsonl | head
+```
+
+## Run on your own data
+
+```bash
+python -m dq_agent run --data path/to/table.parquet --config path/to/rules.yml
+```
+
+Supported:
+- Data: CSV / Parquet
+- Config: YAML / JSON
+
+Guardrails (optional safety limits):
+
+```bash
+python -m dq_agent run \
+  --data path/to/table.parquet \
+  --config path/to/rules.yml \
+  --max-input-mb 50 \
+  --max-rows 500000 \
+  --max-cols 200 \
+  --max-rules 2000 \
+  --max-anomalies 200 \
+  --max-wall-time-s 30
+```
+
+Fail the run when issues reach a severity threshold:
+
+```bash
+python -m dq_agent run --data path/to/table.parquet --config path/to/rules.yml --fail-on ERROR
+```
+
+Exit code behavior:
+- `0`: run completed without triggering `--fail-on`
+- `1`: I/O or config parsing errors (missing/unreadable files, invalid config)
+- `2`: guardrail violation or schema validation failures, plus `--fail-on` severity
+
+Idempotency controls:
+
+```bash
+python -m dq_agent run \
+  --data path/to/table.parquet \
+  --config path/to/rules.yml \
+  --idempotency-key run-001 \
+  --idempotency-mode reuse
+```
+
+Modes:
+- `reuse` (default): if `report.json` + `run_record.json` already exist for the key, return their paths and skip the pipeline.
+- `overwrite`: re-run and overwrite artifacts in the deterministic run directory.
+- `fail`: return a structured error (`idempotency_conflict`) with exit code 2 when artifacts exist.
+
+### Failure contract (typed errors)
+
+Failures are first-class artifacts. When a run fails, both `report.json` and `run_record.json` include an `error`
+object, and the CLI prints a JSON payload with the error and any written output paths.
+
+Error schema fields:
+- `type`: `guardrail_violation` | `io_error` | `config_error` | `schema_validation_error` | `internal_error` | `idempotency_conflict` | `regression`
+- `code`: short, stable machine code (e.g., `max_rows`, `data_not_found`, `invalid_config`)
+- `message`: stable human-readable message
+- `is_retryable`: boolean retry hint
+- `suggested_next_step`: short actionable hint
+- `details`: optional, small JSON object
+
+Failure output example:
+
+```json
+{
+  "error": {
+    "type": "guardrail_violation",
+    "code": "max_rows",
+    "message": "Row count 2500 exceeds limit 10.",
+    "is_retryable": false,
+    "suggested_next_step": "Adjust guardrail limits or reduce input size before retrying.",
+    "details": {"limit": 10, "observed": 2500}
+  },
+  "report_json_path": "artifacts/<run_id>/report.json",
+  "run_record_path": "artifacts/<run_id>/run_record.json"
+}
+```
+
+See all CLI options:
+
+```bash
+python -m dq_agent --help
+python -m dq_agent run --help
+```
+
+## Shadow (baseline vs candidate)
+
+Compare two configs against the same data before promoting changes:
+
+```bash
+python -m dq_agent shadow \
+  --data path/to/table.parquet \
+  --baseline-config path/to/baseline.yml \
+  --candidate-config path/to/candidate.yml \
+  --fail-on-regression
+```
+
+Outputs are grouped under one shadow run directory:
+
+```
+artifacts/<shadow_run_id>/
+  baseline/<baseline_run_id>/...
+  candidate/<candidate_run_id>/...
+  shadow_diff.json
+```
+
+The `--fail-on-regression` flag exits with code `2` when the candidate is worse than the baseline, while still
+writing `shadow_diff.json` and both run artifacts. The CLI prints a single JSON payload with the baseline and
+candidate report paths plus any typed error details.
+
+## Replay a run
+
+After a run completes, use the `run_record.json` to replay deterministically:
+
+```bash
+python -m dq_agent replay --run-record artifacts/<run_id>/run_record.json --strict
+```
+
+## Resume a run with checkpoints
+
+Each run writes a `checkpoint.json` alongside the other artifacts. If artifacts go missing, resume can repair them:
+
+```bash
+python -m dq_agent resume --run-dir artifacts/<run_id>
+```
+
+Example flow:
+
+```bash
+python -m dq_agent demo --output-dir artifacts
+rm artifacts/<run_id>/report.md
+python -m dq_agent resume --run-dir artifacts/<run_id>
+python -m dq_agent validate --kind report --path artifacts/<run_id>/report.json
+python -m dq_agent validate --kind run_record --path artifacts/<run_id>/run_record.json
+python -m dq_agent validate --kind checkpoint --path artifacts/<run_id>/checkpoint.json
+```
+
+## Schema + validation
+
+Print JSON Schema for each output:
+
+```bash
+python -m dq_agent schema --kind report
+python -m dq_agent schema --kind run_record
+python -m dq_agent schema --kind checkpoint
+```
+
+Validate a generated output:
+
+```bash
+python -m dq_agent validate --kind report --path artifacts/<run_id>/report.json
+python -m dq_agent validate --kind run_record --path artifacts/<run_id>/run_record.json
+python -m dq_agent validate --kind checkpoint --path artifacts/<run_id>/checkpoint.json
+```
+
+## Config format (YAML)
+
+Minimal example:
+
+```yaml
+version: 1
+dataset:
+  name: demo_orders
+  primary_key: [order_id]
+  time_column: created_at
+
+columns:
+  order_id:
+    type: string
+    required: true
+    checks:
+      - unique: true
+
+  user_id:
+    type: string
+    required: true
+    checks:
+      - not_null: { max_null_rate: 0.01 }
+      - string_noise: { contains: ["*", "''"], max_rate: 0.0 }
+    anomalies:
+      - missing_rate: { max_rate: 0.02 }
+
+  amount:
+    type: float
+    required: true
+    checks:
+      - range: { min: 0, max: 10000 }
+    anomalies:
+      - outlier_mad: { z: 6.0 }
+
+  status:
+    type: string
+    required: true
+    checks:
+      - allowed_values: { values: ["PAID","REFUND","CANCEL","PENDING"] }
+```
+
+Demo config lives at: `dq_agent/resources/demo_rules.yml`.
+
+## What it checks
+
+Deterministic rules:
+- `not_null`
+- `unique`
+- `range`
+- `allowed_values`
+- `string_noise` (substring / regex pattern based)
+
+Statistical anomalies:
+- `outlier_mad` (robust outliers via MAD z-score)
+- `missing_rate` (null-rate anomaly)
+
+## Benchmarks (real labeled datasets)
+
+We evaluate dq_agent as an **error detector** on datasets that have real labels
+via paired `dirty.csv` / `clean.csv`.
+
+Metrics:
+- **cell-level** precision / recall / F1 (detect wrong cells)
+- **row-level** precision / recall / F1 (detect rows containing any wrong cell)
+
+Reproduce (Raha):
+
+```bash
+bash scripts/run_raha_and_save.sh
+```
+
+Notes:
+- Benchmark harness: `scripts/eval_dirty_clean.py` (auto-generates a config from profile data).
+- The `string_noise` check is **enabled by default** for open-domain string columns in the harness
+  (use `--no-string-noise` to ablate).
+
+Reproduce (PED):
+
+```bash
+bash scripts/run_ped_and_save.sh
+```
+
+To refresh the README benchmark block from `benchmarks/` artifacts:
+
+```bash
+python scripts/update_readme_benchmarks.py
+```
+
+<!-- BENCHMARKS:START -->
+### Raha (7 datasets; dirty vs clean profiles)
+
+| profile | datasets | macro_cell_f1 | micro_cell_f1 | macro_row_f1 | micro_row_f1 | cell_tp/fp/fn | row_tp/fp/fn |
+|---|---:|---:|---:|---:|---:|---:|---:|
+| clean | 7 | 0.817778 | 0.841898 | 0.915870 | 0.925301 | (16662, 3720, 2538) | (12288, 724, 1260) |
+| dirty | 7 | 0.405580 | 0.303776 | 0.593699 | 0.466883 | (4183, 3488, 15686) | (4395, 714, 9323) |
+
+Full breakdown: `benchmarks/raha_compare.md`.
+
+### Raha string-noise ablation (patterns: `*`, `''`)
+
+| metric | base | union | Δ |
+|---|---:|---:|---:|
+| macro_cell_f1 | 0.760961 | 0.817760 | 0.056798 |
+| micro_cell_f1 | 0.806936 | 0.841877 | 0.034940 |
+| macro_row_f1  | 0.859008 | 0.915870 | 0.056862 |
+| micro_row_f1  | 0.876437 | 0.925301 | 0.048864 |
+
+Largest per-dataset gain (from the committed compare file):
+
+| dataset | base cell_f1 | union cell_f1 | Δ | base row_f1 | union row_f1 | Δ |
+|---|---:|---:|---:|---:|---:|---:|
+| raha/tax | 0.319744 | 0.718032 | 0.398288 | 0.324004 | 0.722462 | 0.398457 |
+
+Full breakdown: `benchmarks/raha_noise_union/compare.md`.
+
+### PED (additional dirty/clean datasets)
+
+| profile | datasets | macro_cell_f1 | micro_cell_f1 | macro_row_f1 | micro_row_f1 | cell_tp/fp/fn | row_tp/fp/fn |
+|---|---:|---:|---:|---:|---:|---:|---:|
+| clean | 14 | 0.846318 | 0.056526 | 0.857537 | 0.104772 | (40776, 917613, 443580) | (45356, 455137, 319955) |
+| dirty | 14 | 0.200416 | 0.010962 | 0.212178 | 0.035870 | (7726, 917533, 476630) | (14983, 455111, 350328) |
+
+Full breakdown: `benchmarks/ped_compare.md`.
+<!-- BENCHMARKS:END -->
+
+## Dev / Tests
+
+```bash
+pip install -e ".[test]"
+python -m pytest -q
+```
+
+If you see:
+- `ModuleNotFoundError: typer` / `No module named pytest`
+
+You almost certainly forgot to activate venv:
+
+```bash
+source .venv/bin/activate
+```
+
+## Project layout (high-level)
+
+- `dq_agent/cli.py` – Typer CLI (`run`, `demo`)
+- `dq_agent/loader.py` – CSV/Parquet loader
+- `dq_agent/config.py` – config loading (YAML/JSON)
+- `dq_agent/contract.py` – contract validation
+- `dq_agent/rules/` – deterministic checks (registry-based)
+- `dq_agent/anomalies/` – anomaly detectors (registry-based)
+- `dq_agent/report/` – JSON + Markdown report writers
+- `tests/` – unit + integration tests
+
+## Spec / Roadmap
+
+Full design doc: `A0_SPEC.md`
+
+## Project docs
+
+- `CHANGELOG.md`
+- `CONTRIBUTING.md`
+- `CODE_OF_CONDUCT.md`
+- `SECURITY.md`
+- `docs/publishing.md`
+
+## License
+
+Apache-2.0