wherefore 0.1.0__tar.gz

wherefore-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 2026 ArunMishra1
+
+   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.

wherefore-0.1.0/NOTICE

@@ -0,0 +1,5 @@
+wherefore
+Copyright 2026 ArunMishra1
+
+This product includes software developed as part of the wherefore project
+(https://github.com/ArunMishra1/wherefore).

wherefore-0.1.0/PKG-INFO

@@ -0,0 +1,447 @@
+Metadata-Version: 2.4
+Name: wherefore
+Version: 0.1.0
+Summary: Explains WHY two datasets differ, in plain English, with eval-backed accuracy claims.
+License: Apache-2.0
+Project-URL: Homepage, https://github.com/tracelore/wherefore
+Project-URL: Repository, https://github.com/tracelore/wherefore
+Project-URL: Issues, https://github.com/tracelore/wherefore/issues
+Keywords: data-diff,data-quality,data-migration,csv,datacompy,etl-testing
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Quality Assurance
+Classifier: Topic :: Database
+Classifier: Environment :: Console
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+License-File: NOTICE
+Requires-Dist: pandas>=2.2
+Requires-Dist: numpy>=1.24
+Requires-Dist: datacompy>=1.0
+Requires-Dist: pydantic>=2.0
+Requires-Dist: pyyaml>=6.0
+Requires-Dist: typer>=0.12
+Requires-Dist: anthropic>=0.110
+Requires-Dist: rapidfuzz>=3.0
+Requires-Dist: pyarrow>=14.0
+Requires-Dist: openpyxl>=3.1
+Provides-Extra: dev
+Requires-Dist: pytest>=8.0; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: moto[s3]>=5.2; extra == "dev"
+Provides-Extra: s3
+Requires-Dist: boto3>=1.34; extra == "s3"
+Dynamic: license-file
+
+# wherefore
+
+**Tells you *why* two datasets differ — not just that they do.**
+
+[![CI](https://github.com/tracelore/wherefore/actions/workflows/ci.yml/badge.svg)](https://github.com/tracelore/wherefore/actions/workflows/ci.yml)
+[![License: Apache 2.0](https://img.shields.io/badge/License-Apache%202.0-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0)
+[![Python 3.10+](https://img.shields.io/badge/python-3.10%2B-blue)](https://www.python.org/)
+
+Data diffing tools tell you *that* 40 rows mismatched in `created_at`.
+None of them tell you *why*. `wherefore` is the layer on top of a diff
+that answers that question — in plain English, with real example rows
+cited — and honestly says "I don't recognize this pattern" rather than
+confidently guessing wrong.
+
+**Free and key-free out of the box.** No account, no server, no API
+key required for the diffing and pattern-matching — only the optional
+AI narrative (`--explain`) talks to an external API, and that's off by
+default.
+
+```bash
+pip install -e .
+wherefore compare old_export.csv new_export.csv
+```
+
+```
+$ wherefore compare old_export.csv new_export.csv --explain
+Calling Claude for 1 cluster(s)...
+Compared 5 source rows against 5 target rows.
+Matched rows: 5
+  hire_date: 5 mismatches, matches 'timezone_shift' (confidence 1.00)
+    AI: Every affected row is shifted forward by exactly 5 hours,
+    consistent with a UTC-vs-local-time mismatch introduced during
+    the export. Likely cause: the source system's timestamps were
+    re-interpreted in the wrong timezone during migration.
+
+Full report written to report.md
+```
+
+That's a real run, real output — not a mockup. Try it on your own
+files in two minutes: see [Quickstart](#quickstart).
+
+---
+
+### Contents
+
+[Quickstart](#quickstart) · [Why this exists](#why-this-exists) ·
+[What's built](#whats-built) · [Architecture](#architecture) ·
+[Evals](#evals--why-trust-the-explanations) · [All flags](#all-flags) ·
+[Contributing](#contributing)
+
+---
+
+## Quickstart
+
+```bash
+git clone https://github.com/tracelore/wherefore.git
+cd wherefore
+./dev_setup.sh
+```
+
+This creates a `.venv/`, installs everything, and runs the test suite
+(should show **316 passed**, no API key needed — the test suite uses a
+fake AI provider, zero network calls). Safe to re-run.
+
+Then, on any two files of yours:
+
+```bash
+wherefore compare old_export.csv new_export.csv --output report.md
+```
+
+Works the same with `.csv`, `.json`, `.parquet`, or `.xlsx`/`.xls` —
+mix and match freely, format is auto-detected per file. No key column
+needed; `wherefore` finds one. If it picks wrong, or you have many
+table pairs to check at once (a real migration is dozens of tables,
+not one), see [usage details](#usage) below.
+
+**Don't have a Parquet or Excel file handy?** Make one from the CSVs
+above in two lines, run inside the same activated `.venv` from
+`dev_setup.sh` (so `pandas`/`pyarrow` are already available) — note
+`parse_dates=[...]` on any datetime column, since Parquet and Excel
+store dates natively and pandas needs to know which column is one
+before writing (without it, the column round-trips as plain text and
+date-based patterns like `timezone_shift` won't be detected —
+confirmed by testing this exact gap):
+
+```bash
+python3 -c "
+import pandas as pd
+df = pd.read_csv('old_export.csv', parse_dates=['hire_date'])  # name your actual date column
+df.to_parquet('old_export.parquet', index=False)
+df.to_excel('old_export.xlsx', index=False)
+"
+wherefore compare old_export.parquet new_export.parquet   # or .xlsx
+```
+
+Want the AI explanation, not just the statistical match?
+
+```bash
+export ANTHROPIC_API_KEY="sk-ant-..."
+wherefore compare old_export.csv new_export.csv --explain
+```
+
+Sensitive-looking values (emails, SSNs, card numbers, phone numbers)
+are redacted before anything is sent — on by default, see
+[Privacy & data handling](#privacy--data-handling).
+
+<details>
+<summary>Manual setup, if you'd rather not run the script</summary>
+
+```bash
+python3 -m venv .venv
+source .venv/bin/activate      # Windows: .venv\Scripts\activate
+pip install --upgrade pip
+pip install -e ".[dev]"
+pytest tests/ -v
+```
+
+**Requires Python 3.10+.** Tested on 3.10–3.12. On very recent Python
+(3.14+), pandas/numpy are compatible, but if `pip install` fails, a
+smaller transitive dependency without 3.14 wheels yet is the likely
+cause — try 3.11/3.12 if you hit this.
+</details>
+
+## Why this exists
+
+Imagine two boxes of identical LEGO sets. Someone copied box A into
+box B, but a few pieces are missing or the wrong color. Most tools
+that check this say: *"12 pieces are different."* That's it.
+
+`wherefore` looks at those 12 differences and says: *"These aren't
+random — every one has the same color swapped the same way, consistent
+with a colorblind sort. That's your root cause."* It explains the
+pattern behind the differences, not just the differences themselves.
+
+To know if it's actually doing this well — not just sounding plausible
+— we build our own "messed-up" datasets on purpose, with a known,
+labeled answer, and grade whether the tool finds it. That's the
+[eval harness](#evals--why-trust-the-explanations), and it's
+first-class here, not an afterthought.
+
+This is not a thin prompt wrapper around an LLM. The AI sits behind a
+deterministic clustering and statistical-signature step, and every
+accuracy claim below is backed by that eval harness against labeled
+ground truth — not vibes.
+
+## What's built
+
+🚧 Actively built in public. The full pipeline is real, end-to-end:
+statistical detection, AI explanation, and a scored eval harness.
+
+| | |
+|---|---|
+| **Formats** | CSV, JSON, Parquet, Excel — local or `s3://`, auto-detected, mix-and-match |
+| **Modes** | One file pair (`compare`) or a whole directory (`compare-dir`) |
+| **Taxonomy** | 8 failure patterns built & tested: `timezone_shift`, `truncation`, `enum_drift`, `null_type_coercion`, `float_precision`, `encoding_mismatch`, `dedup_failure`, `key_mismatch` |
+| **AI layer** | Verified against the real Claude API twice — manually and via the scored eval harness — 100% match on a small (seven-fixture) sample |
+| **Privacy** | Redacts emails/SSNs/cards/phones before any `--explain` call, on by default |
+| **Tests** | 316 passing, including a real (mocked) S3 round-trip and end-to-end runs against real generated files |
+
+`dedup_failure` and `key_mismatch` are structurally different from the
+other six — `dedup_failure` detects duplicated rows (re-inserted with
+a new key, not the same key twice); `key_mismatch` detects a row whose
+join key was reformatted (`EMP-1001` vs `EMP1001`) so it never matched
+at all. Both show up as extra/missing rows rather than a column-level
+mismatch, both have their own clustering path
+(`detect_row_presence_patterns`), and both are verified by real,
+dedicated tests — including a regression test confirming they don't
+false-positive on each other's fixtures, and a regression test for a
+real false positive caught while building `key_mismatch` (two
+genuinely unrelated keys sharing a domain's ID prefix scored close
+enough on a similarity heuristic to need a deterministic check
+instead — see `TAXONOMY.md`). Neither is yet wired into the automated
+eval harness above (that harness currently only scores column-mismatch
+patterns) — tracked honestly as a gap, not hidden.
+
+**Not built yet:** wiring `dedup_failure`/`key_mismatch` into the eval
+harness, more fixture coverage at scale, and database connectivity
+(Postgres, MySQL,
+SQLite). File-based sources — local and `s3://` — and CSV/JSON/Parquet/
+Excel are all supported today. See [`TAXONOMY.md`](https://github.com/tracelore/wherefore/blob/main/TAXONOMY.md) for
+the current pattern list and what's planned next.
+
+<details>
+<summary>The harder bugs this surfaced, if you're curious</summary>
+
+Building the 4th pattern (`null_type_coercion`) surfaced three real
+bugs spanning the comparison engine, the file loaders, and the eval
+harness itself. Building the 5th (`float_precision`) surfaced a
+subtler one: a magnitude-based heuristic that looked right scored a
+real false positive on an adversarial test case, fixed by checking the
+underlying mechanism (an exact float32 round-trip) directly instead of
+approximating its size. Full account, including how each was found and
+fixed: [`TAXONOMY_TODO.md`](https://github.com/tracelore/wherefore/blob/main/TAXONOMY_TODO.md).
+</details>
+
+## Architecture
+
+```
+source file, target file        (CSV, JSON, Parquet, or Excel)
+        │
+        ▼
+ loaders + key matching   (exact by default; --fuzzy-keys for reformatted keys)
+        │
+        ▼
+ comparison engine        (wraps datacompy; schema-aware diffing)
+        │
+        ▼
+ deterministic clustering  (groups mismatches; runs cheap statistical
+        │                   signature checks — NO causal claims here)
+        ▼
+ candidate pattern(s), confidence-scored
+        │
+        ├─── default: stop here, statistics only (free, no API key)
+        │
+        ▼  with --explain
+ AI reasoning layer        (Claude; redacts sensitive patterns by default;
+        │                   writes the causal narrative, cites real rows,
+        │                   honestly flags "unrecognized" when nothing fits)
+        ▼
+ Markdown report           (statistics always; AI narrative alongside
+                             the evidence, never instead of it)
+```
+
+**Failure patterns are data, not code.** Each one is a YAML file under
+`src/wherefore/taxonomy/patterns/`, validated against a strict schema.
+Adding a new pattern means writing a YAML file and a small corruptor
+function — never touching clustering or reasoning code. See
+[`CONTRIBUTING.md`](https://github.com/tracelore/wherefore/blob/main/CONTRIBUTING.md) for the contract.
+
+**Clustering and reasoning are deliberately separated.** Clustering
+only ever produces statistical observations ("these 12 rows differ by
+exactly 5 hours"). Causal attribution ("this is a timezone bug") is
+the AI's job, every time — if clustering started asserting causes, the
+AI layer would become decorative and the evals would stop measuring
+anything meaningful.
+
+## Evals — why trust the explanations?
+
+Because we control the ground truth. The synthetic data generator
+creates clean datasets, then deliberately corrupts them using a known
+failure pattern — recording exactly what it did in a committed
+`ground_truth.json`. The eval harness runs the real pipeline against
+these labeled fixtures and scores the result as precision/recall per
+pattern, tracking "correctly said unrecognized" separately from
+"confidently named the wrong pattern" — very different failure modes a
+naive right/wrong scorer would conflate.
+
+**Statistical mode, free, no API key, against all 7 fixtures:**
+
+```
+$ python3 -m evals.harness.run_eval
+Total cases: 7
+Overall accuracy (correct match + honest abstain): 100.00%
+
+  encoding_mismatch: precision=1.00 recall=1.00
+  enum_drift: precision=1.00 recall=1.00
+  float_precision: precision=1.00 recall=1.00
+  null_type_coercion: precision=1.00 recall=1.00
+  timezone_shift: precision=1.00 recall=1.00
+  truncation: precision=1.00 recall=1.00
+```
+
+**LLM mode** (`python3 -m evals.harness.run_eval --llm`, real API
+calls, scores the AI's final answer instead of clustering's raw
+statistics) — **also 100%**, including the one fixture designed to
+test something the statistics alone can't: a cluster that legitimately
+matches two patterns at once, where the AI correctly picked the right
+one by reasoning about the actual values, not by defaulting to
+whichever candidate came first.
+
+Both are reproducible — clone the repo, run the commands yourself.
+Seven fixtures proves the *mechanism* works end-to-end against the real
+API; it doesn't prove either layer is bulletproof at scale. That's the
+honest caveat, and expanding fixture coverage is the tracked next step
+in [`TAXONOMY_TODO.md`](https://github.com/tracelore/wherefore/blob/main/TAXONOMY_TODO.md).
+
+<details>
+<summary>The multi-candidate case, if you want the detail</summary>
+
+`null_type_coercion` and `enum_drift` can legitimately both match the
+same cluster — a null consistently coerced to one sentinel string is,
+statistically, also a "consistent value mapping." Clustering reports
+both honestly rather than guessing which is "more right," since that's
+a causal judgment that belongs to the AI layer, not clustering. The
+eval harness scores this correctly too: a true pattern counts as found
+if it appears anywhere among the reported candidates, not only if it's
+listed first. Full story of how this was found and fixed:
+[`TAXONOMY_TODO.md`](https://github.com/tracelore/wherefore/blob/main/TAXONOMY_TODO.md).
+</details>
+
+## Usage
+
+### One file pair
+
+```bash
+wherefore compare old_export.csv new_export.csv --key employee_id
+```
+
+`--key` is optional — omit it and `wherefore` looks for a column that
+looks like an identifier (mostly-unique values, often named with "id"
+or "key"). If the same record has a differently-formatted key on each
+side (e.g. `EMP-1001` vs `EMP1001`, common after a migration), add
+`--fuzzy-keys`.
+
+Files can live in S3, not just on disk — mix and match freely:
+
+```bash
+pip install "wherefore[s3]"   # boto3 is optional, only needed for s3:// paths
+wherefore compare s3://old-bucket/accounts.csv s3://new-bucket/accounts.csv
+```
+
+Uses the standard AWS credential chain (env vars, `~/.aws/credentials`,
+IAM role, `AWS_PROFILE`) — `wherefore` doesn't invent its own.
+
+### A whole migration, not one table
+
+```bash
+$ wherefore compare-dir old_exports new_exports --output-dir reports
+Found 3 matching file pair(s). Comparing...
+
+  [DIFF] accounts.csv: 1 finding(s) (timezone_shift)
+  [DIFF] patients.csv: 1 finding(s) (truncation)
+  [OK] transactions.csv: no mismatches
+
+Done: 3 compared, 0 skipped. Reports written to reports/
+```
+
+Files are matched by **identical filename** between the two
+directories — no fuzzy matching at the file level, since guessing
+wrong about *which two tables* you're comparing is worse than guessing
+wrong about a row key. A pair that can't be compared (bad format, no
+detectable key) is skipped and reported, not fatal to the rest of the
+batch. Every `compare` flag works here too, applied to every pair.
+
+### What you get without an API key
+
+Real diffing, real grouping, real pattern matching — and a confidence
+score that's a genuine deterministic measurement (e.g. "every
+mismatched value differs by exactly the same 5-hour delta"), not an AI
+guess. If nothing in the taxonomy matches, `wherefore` says
+`pattern unrecognized` rather than forcing one.
+
+### What `--explain` adds
+
+The plain-English *why*, shown **alongside** the statistical evidence
+it was reasoned from, not instead of it — so you can check the claim
+yourself. In testing, the AI correctly identified a genuinely random,
+non-matching corruption and proposed real alternative hypotheses (a
+bad join, a mis-wired column) instead of inventing a pattern that
+wasn't there.
+
+## Privacy & data handling
+
+`--explain` sends mismatched cell values to the Claude API. Before
+that happens, values are checked against a redaction layer — emails,
+SSNs, credit card numbers, US phone numbers — **on by default, no flag
+needed.** Anything masked is called out in the output
+(`Redacted before sending to Claude: email`). Disable with
+`--no-redact` if you've already vetted your data.
+
+Be precise about scope: this is pattern-based detection of
+*structurally recognizable* sensitive data, not a general PII scanner
+— it won't know that a name or a home address is sensitive. Full
+detail, including a documented false-positive case found during
+testing (long numeric IDs can resemble card numbers):
+[`SECURITY.md`](https://github.com/tracelore/wherefore/blob/main/SECURITY.md).
+
+## All flags
+
+<details>
+<summary>Expand</summary>
+
+```bash
+wherefore compare SOURCE TARGET [OPTIONS]
+
+  --key TEXT                   Join key column. Auto-detected if omitted.
+  --fuzzy-keys                 Allow approximate key matching (e.g. 'CUST-001' vs 'CUST001').
+  --output TEXT                Where to write the report (default: report.md).
+  --confidence-threshold FLOAT Minimum confidence to count as a pattern match (default: 0.9).
+  --explain                    Generate plain-English AI explanations via the Claude API.
+                                Requires ANTHROPIC_API_KEY. Makes real, billed API calls. Off by default.
+  --no-redact                  Disable automatic redaction of emails/SSNs/cards/phones before
+                                sending data to Claude with --explain. Redaction is ON by default.
+
+wherefore compare-dir SOURCE_DIR TARGET_DIR [OPTIONS]
+
+  --output-dir TEXT             Directory for one report per pair (default: reports).
+  --key, --fuzzy-keys, --confidence-threshold, --explain, --no-redact   Same as `compare`, applied to every pair.
+```
+</details>
+
+## Contributing
+
+Contributions are welcome, especially new taxonomy patterns. Start
+with [`CONTRIBUTING.md`](https://github.com/tracelore/wherefore/blob/main/CONTRIBUTING.md) — the pattern contract, why
+patterns are built corruptor-first rather than YAML-first, and the
+design decisions worth knowing before you dig in.
+
+Found a security issue? See [`SECURITY.md`](https://github.com/tracelore/wherefore/blob/main/SECURITY.md).
+
+## License
+
+Apache License 2.0 — see [`LICENSE`](https://github.com/tracelore/wherefore/blob/main/LICENSE). Contributions are
+accepted under the same license (see `NOTICE` for attribution).