pipeverify 0.1.0__tar.gz

pipeverify-0.1.0/.gitignore

@@ -0,0 +1,7 @@
+__pycache__/
+*.egg-info/
+.pytest_cache/
+dist/
+build/
+.venv/
+*.db

pipeverify-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

pipeverify-0.1.0/NOTICE

@@ -0,0 +1,2 @@
+pipeverify
+Copyright 2026 Akshay Sharma

pipeverify-0.1.0/PKG-INFO

@@ -0,0 +1,234 @@
+Metadata-Version: 2.5
+Name: pipeverify
+Version: 0.1.0
+Summary: Check that a pipeline change left the data right, not just the job green.
+Project-URL: Homepage, https://github.com/akshaysharma1088/pipeverify
+Project-URL: Issues, https://github.com/akshaysharma1088/pipeverify/issues
+Author: Akshay Sharma
+License-Expression: Apache-2.0
+License-File: LICENSE
+License-File: NOTICE
+Keywords: ci,data-diff,data-engineering,data-quality,duckdb,etl,llm-agents
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Topic :: Database
+Classifier: Topic :: Software Development :: Quality Assurance
+Requires-Python: >=3.9
+Requires-Dist: click>=8.1
+Requires-Dist: duckdb>=1.0
+Requires-Dist: pyyaml>=6.0
+Provides-Extra: ai
+Requires-Dist: anthropic>=0.40; extra == 'ai'
+Requires-Dist: openai>=1.40; extra == 'ai'
+Provides-Extra: dev
+Requires-Dist: pandas>=2.0; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Provides-Extra: sql
+Requires-Dist: pandas>=2.0; extra == 'sql'
+Requires-Dist: sqlalchemy>=2.0; extra == 'sql'
+Description-Content-Type: text/markdown
+
+# pipeverify
+
+**Check that a pipeline change left the data right, not just the job green.**
+
+[![ci](https://github.com/akshaysharma1088/pipeverify/actions/workflows/ci.yml/badge.svg)](https://github.com/akshaysharma1088/pipeverify/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+![Python](https://img.shields.io/badge/python-3.9%2B-blue)
+![Status](https://img.shields.io/badge/status-alpha-orange)
+
+A pipeline change can pass every test, finish on time and keep the schema intact while quietly
+dropping rows, duplicating keys or changing what a column means. More of these changes are now
+written by AI coding agents, which makes "the job succeeded" an even weaker signal.
+
+pipeverify compares your tables **before and after** a change and gives a verdict:
+
+| Verdict | Meaning | Default CI behaviour |
+|---|---|---|
+| ✅ **PASS** | The data is the same where it should be. | Merge |
+| 🟡 **REVIEW** | Something changed that tests would not catch. A person should look. | Merge allowed, flagged |
+| ⛔ **BLOCK** | The change damages the data. | Fail the check |
+
+It works with any tool that produces tables: SQL scripts, Spark jobs, dbt, Airflow tasks or an AI
+agent's fix. It needs two snapshots, nothing else.
+
+## Why
+
+In the [PipeMend benchmark](https://github.com/akshaysharma1088/pipemend)
+([DOI 10.5281/zenodo.23510784](https://doi.org/10.5281/zenodo.23510784)), LLM agents repaired
+64 data pipeline incidents. Production-style data quality monitors approved **every** harmful fix
+the agents made. What caught them was comparing the data itself. pipeverify packages that check
+so any team can run it on every change.
+
+## Quick start
+
+```bash
+pip install pipeverify
+
+# compare two snapshots of one table
+pipeverify compare before/orders.parquet after/orders.parquet --key order_id
+```
+
+```
+BLOCK   orders.parquet
+        rows 1,200 -> 1,000, matched 1,000
+        BLOCK  Table lost 200 rows (16.67%)
+        BLOCK  200 key(s) present before are gone after (16.67%)
+        BLOCK  Total of 'revenue' moved 16.71% (1,383,131.25 -> 1,152,000.00)
+
+Verdict: BLOCK  This change damages the data. Do not merge as is.
+```
+
+Try the bundled demo, five realistic changes to a retail sales table:
+
+```bash
+git clone https://github.com/akshaysharma1088/pipeverify && cd pipeverify
+pip install -e .
+python examples/retail/make_demo.py
+for s in examples/retail/scenarios/*/; do pipeverify run -c "$s/pipeverify.yml"; done
+```
+
+| Scenario | What happened | Verdict |
+|---|---|---|
+| `1_safe_fix` | Revenue restated for late refunds on one day, as intended | ✅ PASS |
+| `2_dedupe_drops_rows` | Duplicates removed on the wrong columns, real days dropped | ⛔ BLOCK |
+| `3_join_fanout` | A join to a dimension with a duplicate row doubled one store | ⛔ BLOCK |
+| `4_unit_change` | Upstream started sending one region's revenue in cents | ⛔ BLOCK |
+| `5_null_creep` | A renamed source field left region empty for new stores | 🟡 REVIEW |
+
+Every one of these runs successfully and keeps the same schema.
+
+## Sources
+
+`before` and `after` can each be:
+
+| Source | CLI form | Config form |
+|---|---|---|
+| CSV, Parquet, JSON file | `data/orders.parquet` | `path: data/orders.parquet` |
+| DuckDB table | `duckdb:warehouse.db:gold.orders` | `{duckdb: warehouse.db, table: gold.orders}` |
+| DuckDB query | `"duckdb:warehouse.db:SELECT ..."` | `{duckdb: warehouse.db, query: "SELECT ..."}` |
+| Any SQLAlchemy database (Postgres, Snowflake, BigQuery, ...) | | `{url: "postgresql://${PGUSER}@host/db", table: gold.orders}` |
+| pandas DataFrame | | Python API |
+
+SQL databases need `pip install "pipeverify[sql]"` plus the driver for your database. Environment
+variables in URLs are expanded, so credentials stay out of the config file.
+
+## Config
+
+Check many tables at once with `pipeverify.yml` (`pipeverify init` writes a starter file):
+
+```yaml
+thresholds:              # optional, overrides the defaults below for every table
+  row_change_block_pct: 10
+tables:
+  - name: gold.daily_sales
+    before: snapshots/main/daily_sales.parquet
+    after: snapshots/pr/daily_sales.parquet
+    key: [store_id, sale_date]
+    expect_change: [revenue]   # columns this change is meant to modify
+    ignore: [loaded_at]        # columns that always change
+  - name: gold.customers
+    before: {url: "${WAREHOUSE_URL}", table: prod.customers}
+    after: {url: "${WAREHOUSE_URL}", table: pr_123.customers}
+    key: [customer_id]
+    expect_row_change: true    # this change is meant to add or remove rows
+```
+
+```bash
+pipeverify run                     # uses ./pipeverify.yml
+pipeverify run --fail-on review    # stricter: fail CI on REVIEW too
+pipeverify run --format markdown -o report.md
+pipeverify run --json-out report.json
+```
+
+Exit code is `1` when the verdict reaches `--fail-on` (default `block`), otherwise `0`.
+
+## What it checks
+
+| Check | Catches | Default |
+|---|---|---|
+| Schema | Removed, added or retyped columns | removed: BLOCK, retyped: REVIEW |
+| Row count | Rows lost or gained | REVIEW > 1%, BLOCK ≥ 10% |
+| Missing keys | Rows that existed before and are gone | REVIEW on any, BLOCK ≥ 5% |
+| New keys | Rows that did not exist before | REVIEW |
+| Duplicate keys | Fan-out from joins, double loads | BLOCK on any new duplicate |
+| Null rate | Columns going empty | REVIEW > 1 pt, BLOCK ≥ 10 pts |
+| Changed values | Matched rows whose values changed, per column | REVIEW on any, BLOCK ≥ 10% |
+| Column totals | Unit changes, partial loads, double counting | REVIEW > 0.5%, BLOCK ≥ 5% |
+| Category values | New codes in low-cardinality text columns | REVIEW |
+
+Columns listed in `expect_change` are reported but never raise the verdict. All thresholds can be
+changed globally or per table; see [`pipeverify/checks.py`](pipeverify/checks.py) for every option.
+
+## GitHub Action
+
+```yaml
+# .github/workflows/pipeverify.yml
+on: pull_request
+permissions:
+  contents: read
+  pull-requests: write
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      # ... build the "after" snapshots for this PR here ...
+      - uses: akshaysharma1088/pipeverify@v0.1.0
+        with:
+          config: pipeverify.yml
+          fail-on: block      # or review, or never
+```
+
+The action posts the report as a PR comment and in the job summary, and exposes the verdict as an
+output.
+
+## Python API
+
+```python
+import pipeverify
+
+result = pipeverify.verify(before_df, after_df, key="order_id", expect_change=["status"])
+print(result.verdict)              # "pass" | "review" | "block"
+for f in result.findings:
+    print(f.severity, f.message)
+```
+
+Useful inside an Airflow task, a notebook, or an AI agent's own loop: let the agent propose a fix,
+run `verify`, and only apply the fix on PASS.
+
+## Optional AI explanation
+
+```bash
+export ANTHROPIC_API_KEY=...       # or OPENAI_API_KEY with PIPEVERIFY_LLM_MODEL
+pip install "pipeverify[ai]"
+pipeverify run --explain
+```
+
+This adds a short plain-English explanation of what probably happened and what to check next.
+It is off by default. Only the findings are sent (check names, counts, percentages, column names);
+example values from your data are removed first. The verdict never depends on the LLM.
+
+## Roadmap
+
+- Native adapters for dbt (compare a PR's models against production), Airflow and Spark
+- Sampling and pushdown for very large tables, so checks run in the warehouse
+- Rules learned from history: what "normal" change looks like for each table
+- Agent integration: a guardrail that coding and data agents call before applying a change
+
+Ideas and pull requests are welcome; see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Status
+
+Alpha. The checks and verdicts are stable enough to try in CI; options and output formats may
+still change before 1.0.
+
+## Citation
+
+If you use pipeverify in research, please cite the PipeMend benchmark that motivated it
+(see [CITATION.cff](CITATION.cff)).
+
+## License
+
+Apache-2.0

pipeverify-0.1.0/README.md

@@ -0,0 +1,203 @@
+# pipeverify
+
+**Check that a pipeline change left the data right, not just the job green.**
+
+[![ci](https://github.com/akshaysharma1088/pipeverify/actions/workflows/ci.yml/badge.svg)](https://github.com/akshaysharma1088/pipeverify/actions/workflows/ci.yml)
+[![License](https://img.shields.io/badge/license-Apache--2.0-blue.svg)](LICENSE)
+![Python](https://img.shields.io/badge/python-3.9%2B-blue)
+![Status](https://img.shields.io/badge/status-alpha-orange)
+
+A pipeline change can pass every test, finish on time and keep the schema intact while quietly
+dropping rows, duplicating keys or changing what a column means. More of these changes are now
+written by AI coding agents, which makes "the job succeeded" an even weaker signal.
+
+pipeverify compares your tables **before and after** a change and gives a verdict:
+
+| Verdict | Meaning | Default CI behaviour |
+|---|---|---|
+| ✅ **PASS** | The data is the same where it should be. | Merge |
+| 🟡 **REVIEW** | Something changed that tests would not catch. A person should look. | Merge allowed, flagged |
+| ⛔ **BLOCK** | The change damages the data. | Fail the check |
+
+It works with any tool that produces tables: SQL scripts, Spark jobs, dbt, Airflow tasks or an AI
+agent's fix. It needs two snapshots, nothing else.
+
+## Why
+
+In the [PipeMend benchmark](https://github.com/akshaysharma1088/pipemend)
+([DOI 10.5281/zenodo.23510784](https://doi.org/10.5281/zenodo.23510784)), LLM agents repaired
+64 data pipeline incidents. Production-style data quality monitors approved **every** harmful fix
+the agents made. What caught them was comparing the data itself. pipeverify packages that check
+so any team can run it on every change.
+
+## Quick start
+
+```bash
+pip install pipeverify
+
+# compare two snapshots of one table
+pipeverify compare before/orders.parquet after/orders.parquet --key order_id
+```
+
+```
+BLOCK   orders.parquet
+        rows 1,200 -> 1,000, matched 1,000
+        BLOCK  Table lost 200 rows (16.67%)
+        BLOCK  200 key(s) present before are gone after (16.67%)
+        BLOCK  Total of 'revenue' moved 16.71% (1,383,131.25 -> 1,152,000.00)
+
+Verdict: BLOCK  This change damages the data. Do not merge as is.
+```
+
+Try the bundled demo, five realistic changes to a retail sales table:
+
+```bash
+git clone https://github.com/akshaysharma1088/pipeverify && cd pipeverify
+pip install -e .
+python examples/retail/make_demo.py
+for s in examples/retail/scenarios/*/; do pipeverify run -c "$s/pipeverify.yml"; done
+```
+
+| Scenario | What happened | Verdict |
+|---|---|---|
+| `1_safe_fix` | Revenue restated for late refunds on one day, as intended | ✅ PASS |
+| `2_dedupe_drops_rows` | Duplicates removed on the wrong columns, real days dropped | ⛔ BLOCK |
+| `3_join_fanout` | A join to a dimension with a duplicate row doubled one store | ⛔ BLOCK |
+| `4_unit_change` | Upstream started sending one region's revenue in cents | ⛔ BLOCK |
+| `5_null_creep` | A renamed source field left region empty for new stores | 🟡 REVIEW |
+
+Every one of these runs successfully and keeps the same schema.
+
+## Sources
+
+`before` and `after` can each be:
+
+| Source | CLI form | Config form |
+|---|---|---|
+| CSV, Parquet, JSON file | `data/orders.parquet` | `path: data/orders.parquet` |
+| DuckDB table | `duckdb:warehouse.db:gold.orders` | `{duckdb: warehouse.db, table: gold.orders}` |
+| DuckDB query | `"duckdb:warehouse.db:SELECT ..."` | `{duckdb: warehouse.db, query: "SELECT ..."}` |
+| Any SQLAlchemy database (Postgres, Snowflake, BigQuery, ...) | | `{url: "postgresql://${PGUSER}@host/db", table: gold.orders}` |
+| pandas DataFrame | | Python API |
+
+SQL databases need `pip install "pipeverify[sql]"` plus the driver for your database. Environment
+variables in URLs are expanded, so credentials stay out of the config file.
+
+## Config
+
+Check many tables at once with `pipeverify.yml` (`pipeverify init` writes a starter file):
+
+```yaml
+thresholds:              # optional, overrides the defaults below for every table
+  row_change_block_pct: 10
+tables:
+  - name: gold.daily_sales
+    before: snapshots/main/daily_sales.parquet
+    after: snapshots/pr/daily_sales.parquet
+    key: [store_id, sale_date]
+    expect_change: [revenue]   # columns this change is meant to modify
+    ignore: [loaded_at]        # columns that always change
+  - name: gold.customers
+    before: {url: "${WAREHOUSE_URL}", table: prod.customers}
+    after: {url: "${WAREHOUSE_URL}", table: pr_123.customers}
+    key: [customer_id]
+    expect_row_change: true    # this change is meant to add or remove rows
+```
+
+```bash
+pipeverify run                     # uses ./pipeverify.yml
+pipeverify run --fail-on review    # stricter: fail CI on REVIEW too
+pipeverify run --format markdown -o report.md
+pipeverify run --json-out report.json
+```
+
+Exit code is `1` when the verdict reaches `--fail-on` (default `block`), otherwise `0`.
+
+## What it checks
+
+| Check | Catches | Default |
+|---|---|---|
+| Schema | Removed, added or retyped columns | removed: BLOCK, retyped: REVIEW |
+| Row count | Rows lost or gained | REVIEW > 1%, BLOCK ≥ 10% |
+| Missing keys | Rows that existed before and are gone | REVIEW on any, BLOCK ≥ 5% |
+| New keys | Rows that did not exist before | REVIEW |
+| Duplicate keys | Fan-out from joins, double loads | BLOCK on any new duplicate |
+| Null rate | Columns going empty | REVIEW > 1 pt, BLOCK ≥ 10 pts |
+| Changed values | Matched rows whose values changed, per column | REVIEW on any, BLOCK ≥ 10% |
+| Column totals | Unit changes, partial loads, double counting | REVIEW > 0.5%, BLOCK ≥ 5% |
+| Category values | New codes in low-cardinality text columns | REVIEW |
+
+Columns listed in `expect_change` are reported but never raise the verdict. All thresholds can be
+changed globally or per table; see [`pipeverify/checks.py`](pipeverify/checks.py) for every option.
+
+## GitHub Action
+
+```yaml
+# .github/workflows/pipeverify.yml
+on: pull_request
+permissions:
+  contents: read
+  pull-requests: write
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      # ... build the "after" snapshots for this PR here ...
+      - uses: akshaysharma1088/pipeverify@v0.1.0
+        with:
+          config: pipeverify.yml
+          fail-on: block      # or review, or never
+```
+
+The action posts the report as a PR comment and in the job summary, and exposes the verdict as an
+output.
+
+## Python API
+
+```python
+import pipeverify
+
+result = pipeverify.verify(before_df, after_df, key="order_id", expect_change=["status"])
+print(result.verdict)              # "pass" | "review" | "block"
+for f in result.findings:
+    print(f.severity, f.message)
+```
+
+Useful inside an Airflow task, a notebook, or an AI agent's own loop: let the agent propose a fix,
+run `verify`, and only apply the fix on PASS.
+
+## Optional AI explanation
+
+```bash
+export ANTHROPIC_API_KEY=...       # or OPENAI_API_KEY with PIPEVERIFY_LLM_MODEL
+pip install "pipeverify[ai]"
+pipeverify run --explain
+```
+
+This adds a short plain-English explanation of what probably happened and what to check next.
+It is off by default. Only the findings are sent (check names, counts, percentages, column names);
+example values from your data are removed first. The verdict never depends on the LLM.
+
+## Roadmap
+
+- Native adapters for dbt (compare a PR's models against production), Airflow and Spark
+- Sampling and pushdown for very large tables, so checks run in the warehouse
+- Rules learned from history: what "normal" change looks like for each table
+- Agent integration: a guardrail that coding and data agents call before applying a change
+
+Ideas and pull requests are welcome; see [CONTRIBUTING.md](CONTRIBUTING.md).
+
+## Status
+
+Alpha. The checks and verdicts are stable enough to try in CI; options and output formats may
+still change before 1.0.
+
+## Citation
+
+If you use pipeverify in research, please cite the PipeMend benchmark that motivated it
+(see [CITATION.cff](CITATION.cff)).
+
+## License
+
+Apache-2.0

pipeverify-0.1.0/pipeverify/__init__.py

@@ -0,0 +1,8 @@
+"""pipeverify: check that a pipeline change left the data right, not just the job green."""
+
+__version__ = "0.1.0"
+
+from .checks import Finding, Thresholds  # noqa: E402
+from .core import RunResult, TableResult, run_config, verify  # noqa: E402
+
+__all__ = ["verify", "run_config", "Thresholds", "Finding", "TableResult", "RunResult", "__version__"]