cleanframe-engine 0.5.0__tar.gz → 0.5.1__tar.gz

{cleanframe_engine-0.5.0 → cleanframe_engine-0.5.1}/CHANGELOG.md

@@ -7,6 +7,23 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 
 ## [Unreleased]
 
+## [0.5.1] — 2026-10-19
+
+One logo everywhere, a README hero made from real output, and a correct row count in `cleanframe demo`.
+
+### Changed
+
+- The HTML profiling and diff reports show the CleanFrame mark in their header, the same mark as the
+  README, the docs and the playground. `docs/assets/Logo.svg` is now the one source of the mark.
+- The README hero is rendered from a real `cleanframe demo` run by `scripts/render_brand_assets.py`, in a
+  light and a dark version: the messy file, the recipe excerpt, the clean output with its quarantined row,
+  and the drift stop on next month's file. It replaces an illustration whose steps were not CleanFrame ops.
+
+### Fixed
+
+- `cleanframe demo` said "1 duplicate row(s) dropped" for the row it had quarantined. Its summary now
+  reports the quarantined row on its own and names duplicates only when the recipe dropped some.
+
 ## [0.5.0] — 2026-10-18
 
 Decision models, agents, a playground and data CI. CleanFrame can now ask a typed decision model
@@ -499,7 +516,10 @@ now fail loudly, and a few transforms that quietly corrupted data no longer run.
   deterministic executor, validation/quarantine, cell-level diff, schema drift, HTML reports,
   codegen, and CLI.
 
-[Unreleased]: https://github.com/inboxpraveen/Cleanframe/compare/v0.3.1...HEAD
+[Unreleased]: https://github.com/inboxpraveen/Cleanframe/compare/v0.5.1...HEAD
+[0.5.1]: https://github.com/inboxpraveen/Cleanframe/releases/tag/v0.5.1
+[0.5.0]: https://github.com/inboxpraveen/Cleanframe/releases/tag/v0.5.0
+[0.4.0]: https://github.com/inboxpraveen/Cleanframe/releases/tag/v0.4.0
 [0.3.1]: https://github.com/inboxpraveen/Cleanframe/releases/tag/v0.3.1
 [0.3.0]: https://github.com/inboxpraveen/Cleanframe/releases/tag/v0.3.0
 [0.2.0]: https://github.com/inboxpraveen/Cleanframe/commits/main

{cleanframe_engine-0.5.0 → cleanframe_engine-0.5.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.5
 Name: cleanframe-engine
-Version: 0.5.0
+Version: 0.5.1
 Summary: The reproducible data-cleaning engine for Python. AI writes the recipe once; the recipe runs forever — deterministic, diffable, reviewable.
 Project-URL: Homepage, https://github.com/inboxpraveen/Cleanframe
 Project-URL: Repository, https://github.com/inboxpraveen/Cleanframe
@@ -60,7 +60,7 @@ Requires-Dist: pyarrow>=12.0; extra == 'parquet'
 Description-Content-Type: text/markdown
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/inboxpraveen/Cleanframe/main/docs/assets/Logo.png" alt="CleanFrame logo" width="180" />
+  <img src="https://raw.githubusercontent.com/inboxpraveen/Cleanframe/main/docs/assets/Logo.svg" alt="CleanFrame logo" width="120" />
 </p>
 
 <h1 align="center">CleanFrame</h1>
@@ -76,7 +76,10 @@ Description-Content-Type: text/markdown
 </p>
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/inboxpraveen/Cleanframe/main/docs/assets/Hero.png" width="auto" alt="CleanFrame"/>
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/inboxpraveen/Cleanframe/main/docs/assets/Hero-dark.png">
+    <img src="https://raw.githubusercontent.com/inboxpraveen/Cleanframe/main/docs/assets/Hero.png" width="100%" alt="Real output of cleanframe demo: a messy customers CSV becomes clean data through a reviewable YAML recipe. Changed cells are highlighted, a row with an invalid email is held in quarantine, and next month's renamed column stops the replay."/>
+  </picture>
 </p>
 
 <p align="center">
@@ -275,7 +278,7 @@ Fail a pull request when a data file drifts from its committed recipe:
 
 ```yaml
 - uses: actions/checkout@v7
-- uses: inboxpraveen/Cleanframe/action@v0.5.0
+- uses: inboxpraveen/Cleanframe/action@v0.5.1
   with:
     files: data/incoming/*.csv
     recipe: recipes/customer.recipe.yaml
@@ -432,13 +435,16 @@ CleanFrame is free, Apache-2.0, and will stay that way. No feature is paywalled
 and a messy CSV. If it saves your team recurring hours, [sponsorship](https://github.com/sponsors/inboxpraveen)
 funds detector coverage, CleanBench runs on new models, and fast fixes for anything that costs you data.
 
-| Tier | What it funds, and what you get |
+| Tier | What you get |
 |---|---|
-| **Supporter** ($5/mo) | Your name in the release notes |
-| **Cleaner** ($25/mo) | Your detector request jumps the queue |
-| **Team** ($100/mo) | Logo here, priority bug triage, a vote on the roadmap |
-| **Production** ($500/mo) | A quarterly recipe/pipeline review call and private CleanBench runs on your anonymised data |
-| **One-time** | A regional detector pack (India GST/PAN/lakh–crore, EU IBAN/VAT, …) built in the open, credited to you |
+| **$5/mo** | Your name in the sponsors list |
+| **$25/mo** | Your name and a link in this README; issues you open are looked at first |
+| **$100/mo**: retainer, patch on demand | I build the recipe for one recurring file (a vendor export, a settlement report, a CRM dump). You own it and run it; when the format changes, I patch it within 3 business days |
+| **$150/mo**: company sponsor | A short section near the top of this README with your logo, a link and two or three lines you write, plus a mention in the release notes |
+| **$200/mo**: retainer, monthly run | Patch on demand, plus I run the recipe on each new file and send the cleaned output with a cell-level diff, and one custom detector per quarter. Your data stays on my machine, is never shared or used for training, and is deleted after 30 days |
+| **$250 one-time**: recipe build | Send one file. You get a schema and a complete recipe committed to your repo, the cleaned output with a report and a diff of every changed cell, a 30-minute handover call, and 30 days of support |
+
+The [Sponsors page](https://github.com/sponsors/inboxpraveen) has the current tiers and terms.
 
 ---
 

{cleanframe_engine-0.5.0 → cleanframe_engine-0.5.1}/README.md

@@ -1,5 +1,5 @@
 <p align="center">
-  <img src="https://raw.githubusercontent.com/inboxpraveen/Cleanframe/main/docs/assets/Logo.png" alt="CleanFrame logo" width="180" />
+  <img src="https://raw.githubusercontent.com/inboxpraveen/Cleanframe/main/docs/assets/Logo.svg" alt="CleanFrame logo" width="120" />
 </p>
 
 <h1 align="center">CleanFrame</h1>
@@ -15,7 +15,10 @@
 </p>
 
 <p align="center">
-  <img src="https://raw.githubusercontent.com/inboxpraveen/Cleanframe/main/docs/assets/Hero.png" width="auto" alt="CleanFrame"/>
+  <picture>
+    <source media="(prefers-color-scheme: dark)" srcset="https://raw.githubusercontent.com/inboxpraveen/Cleanframe/main/docs/assets/Hero-dark.png">
+    <img src="https://raw.githubusercontent.com/inboxpraveen/Cleanframe/main/docs/assets/Hero.png" width="100%" alt="Real output of cleanframe demo: a messy customers CSV becomes clean data through a reviewable YAML recipe. Changed cells are highlighted, a row with an invalid email is held in quarantine, and next month's renamed column stops the replay."/>
+  </picture>
 </p>
 
 <p align="center">
@@ -214,7 +217,7 @@ Fail a pull request when a data file drifts from its committed recipe:
 
 ```yaml
 - uses: actions/checkout@v7
-- uses: inboxpraveen/Cleanframe/action@v0.5.0
+- uses: inboxpraveen/Cleanframe/action@v0.5.1
   with:
     files: data/incoming/*.csv
     recipe: recipes/customer.recipe.yaml
@@ -371,13 +374,16 @@ CleanFrame is free, Apache-2.0, and will stay that way. No feature is paywalled
 and a messy CSV. If it saves your team recurring hours, [sponsorship](https://github.com/sponsors/inboxpraveen)
 funds detector coverage, CleanBench runs on new models, and fast fixes for anything that costs you data.
 
-| Tier | What it funds, and what you get |
+| Tier | What you get |
 |---|---|
-| **Supporter** ($5/mo) | Your name in the release notes |
-| **Cleaner** ($25/mo) | Your detector request jumps the queue |
-| **Team** ($100/mo) | Logo here, priority bug triage, a vote on the roadmap |
-| **Production** ($500/mo) | A quarterly recipe/pipeline review call and private CleanBench runs on your anonymised data |
-| **One-time** | A regional detector pack (India GST/PAN/lakh–crore, EU IBAN/VAT, …) built in the open, credited to you |
+| **$5/mo** | Your name in the sponsors list |
+| **$25/mo** | Your name and a link in this README; issues you open are looked at first |
+| **$100/mo**: retainer, patch on demand | I build the recipe for one recurring file (a vendor export, a settlement report, a CRM dump). You own it and run it; when the format changes, I patch it within 3 business days |
+| **$150/mo**: company sponsor | A short section near the top of this README with your logo, a link and two or three lines you write, plus a mention in the release notes |
+| **$200/mo**: retainer, monthly run | Patch on demand, plus I run the recipe on each new file and send the cleaned output with a cell-level diff, and one custom detector per quarter. Your data stays on my machine, is never shared or used for training, and is deleted after 30 days |
+| **$250 one-time**: recipe build | Send one file. You get a schema and a complete recipe committed to your repo, the cleaned output with a report and a diff of every changed cell, a 30-minute handover call, and 30 days of support |
+
+The [Sponsors page](https://github.com/sponsors/inboxpraveen) has the current tiers and terms.
 
 ---
 

cleanframe_engine-0.5.1/cleanframe/_version.py

@@ -0,0 +1 @@
+__version__ = "0.5.1"

{cleanframe_engine-0.5.0 → cleanframe_engine-0.5.1}/cleanframe/cli.py

@@ -348,11 +348,13 @@ def _cmd_demo(args: argparse.Namespace) -> int:
         f"--recipe {run.files['recipe']} --out {run.files['clean']} "
         f"--code {run.files['code']} --report {run.files['diff']}"
     )
-    _emit(
-        f"   {s.get('changed_cells', 0)} cell(s) changed in {s.get('changed_columns', 0)} column(s), "
-        f"{s.get('rows_dropped', 0)} duplicate row(s) dropped, {run.quarantined} row(s) quarantined "
-        "(held with a reason, never deleted)"
-    )
+    parts = [f"{s.get('changed_cells', 0)} cell(s) changed in {s.get('changed_columns', 0)} column(s)"]
+    if run.duplicates:
+        parts.append(f"{run.duplicates} duplicate row(s) dropped")
+    if run.dropped:
+        parts.append(f"{run.dropped} other row(s) dropped")
+    parts.append(f"{run.quarantined} row(s) quarantined (held with a reason, never deleted)")
+    _emit("   " + ", ".join(parts))
     _note(diff=s, rows_quarantined=run.quarantined)
     for key in ("recipe", "clean", "code", "diff"):
         _emit(f"   ✓ {run.files[key]}")

{cleanframe_engine-0.5.0 → cleanframe_engine-0.5.1}/cleanframe/demo.py

@@ -42,6 +42,10 @@ class DemoRun:
     issues: list = field(default_factory=list)
     clean_summary: dict = field(default_factory=dict)
     quarantined: int = 0
+    #: Exact duplicate rows the recipe dropped (quarantined rows are not counted here).
+    duplicates: int = 0
+    #: Rows dropped for any other reason: a ``drop`` validation rule or a plugin frame op.
+    dropped: int = 0
     drift_text: str = ""
     patch_notes: list[str] = field(default_factory=list)
     replay_rows: int = 0
@@ -98,6 +102,11 @@ def run_demo(directory: str | Path, *, overwrite: bool = False) -> DemoRun:
         result.report(run.files["diff"])
         run.clean_summary = result.diff.summary()
         run.quarantined = int(len(result.quarantine))
+        # diff.dropped_rows lists every row missing from the clean output, the
+        # quarantined ones included, so split it before naming any count.
+        removed = result.diff.dropped_rows
+        run.duplicates = sum(1 for _, reason in removed if reason == "dedup")
+        run.dropped = len(removed) - run.quarantined - run.duplicates
 
         next_month = run.files["next_month_customers.csv"]
         try:

{cleanframe_engine-0.5.0 → cleanframe_engine-0.5.1}/cleanframe/report.py

@@ -54,9 +54,13 @@ body {
   font: 15px/1.55 -apple-system, BlinkMacSystemFont, "Segoe UI", Roboto, Helvetica, Arial, sans-serif;
 }
 .wrap { max-width: 1040px; margin: 0 auto; padding: 32px 20px 80px; }
-header.masthead { display: flex; align-items: baseline; gap: 12px; flex-wrap: wrap;
+header.masthead { display: flex; align-items: center; gap: 12px; flex-wrap: wrap;
   border-bottom: 1px solid var(--border); padding-bottom: 16px; margin-bottom: 24px; }
-header.masthead h1 { font-size: 22px; margin: 0; letter-spacing: -0.02em; }
+header.masthead h1 { font-size: 22px; margin: 0; letter-spacing: -0.02em;
+  display: flex; align-items: center; gap: 10px; }
+header.masthead .mark { width: 26px; height: 26px; flex: none; }
+.mark .c { fill: #06b6d4; } .mark .s { fill: #5a6780; }
+@media (prefers-color-scheme: dark) { .mark .c { fill: #22d3ee; } .mark .s { fill: #64748b; } }
 header.masthead .sub { color: var(--muted); font-size: 14px; }
 .grid { display: grid; gap: 16px; }
 .stats { grid-template-columns: repeat(auto-fit, minmax(150px, 1fr)); margin-bottom: 28px; }
@@ -109,7 +113,7 @@ _BASE = """<!doctype html>
 </head>
 <body><div class="wrap">
 <header class="masthead">
-  <h1>CleanFrame</h1>
+  <h1><svg class="mark" viewBox="0 0 64 64" aria-hidden="true"><defs><linearGradient id="cf-mark-frame" x1="0" y1="0" x2="1" y2="1"><stop offset="0" stop-color="#06b6d4"/><stop offset=".5" stop-color="#3b82f6"/><stop offset="1" stop-color="#8b5cf6"/></linearGradient></defs><path d="M5 21V5h16M43 5h16v16M59 43v16H43M21 59H5V43" fill="none" stroke="url(#cf-mark-frame)" stroke-width="6"/><g class="c"><rect x="15" y="15" width="10" height="10"/><rect x="39" y="15" width="10" height="10"/><rect x="27" y="27" width="10" height="10"/><rect x="15" y="39" width="10" height="10"/><rect x="39" y="39" width="10" height="10"/></g><g class="s"><rect x="27" y="15" width="10" height="10"/><rect x="15" y="27" width="10" height="10"/><rect x="39" y="27" width="10" height="10"/><rect x="27" y="39" width="10" height="10"/></g></svg>CleanFrame</h1>
   <span class="sub">{{ subtitle }}</span>
 </header>
 {{ body|safe }}

{cleanframe_engine-0.5.0 → cleanframe_engine-0.5.1}/docs/README.md

@@ -1,3 +1,5 @@
+<img src="assets/Logo.svg" alt="CleanFrame logo" width="72" />
+
 # CleanFrame documentation
 
 Welcome. This folder is the **in-repo** documentation for CleanFrame.

{cleanframe_engine-0.5.0 → cleanframe_engine-0.5.1}/docs/github-action.md

@@ -6,7 +6,7 @@ drifted from its recipe or a validation fails, and writes a per-file table to th
 summary.
 
 ```yaml
-- uses: inboxpraveen/Cleanframe/action@v0.5.0
+- uses: inboxpraveen/Cleanframe/action@v0.5.1
   with:
     files: data/incoming/*.csv
     recipe: recipes/customer.recipe.yaml
@@ -151,7 +151,7 @@ Full YAML for each setup: [`action/README.md`](../action/README.md#recipes).
 
 | `uses:` | `cleanframe-version` empty installs |
 |---------|-------------------------------------|
-| `inboxpraveen/Cleanframe/action@v0.5.0` | CleanFrame **from the same checkout** as the action, so action and library are one release |
+| `inboxpraveen/Cleanframe/action@v0.5.1` | CleanFrame **from the same checkout** as the action, so action and library are one release |
 | `inboxpraveen/cleanframe-action@v1` (Marketplace) | The CleanFrame release pinned by that action release |
 
 For a fully reproducible run, pin a tag or commit SHA in `uses:` and set

{cleanframe_engine-0.5.0 → cleanframe_engine-0.5.1}/examples/github-action/data-ci.yml

@@ -36,7 +36,7 @@ jobs:
 
       - name: Replay committed recipe
         id: cleanframe
-        uses: inboxpraveen/Cleanframe/action@v0.5.0
+        uses: inboxpraveen/Cleanframe/action@v0.5.1
         with:
           files: |                           # <- adjust: one path or glob per line
             data/incoming/*.csv

{cleanframe_engine-0.5.0 → cleanframe_engine-0.5.1}/tests/test_demo.py

@@ -33,6 +33,9 @@ def test_demo_runs_report_clean_drift_and_patch(tmp_path):
         assert Path(run.files[key]).is_file(), key
     assert run.quality is not None and 0 <= run.quality.score <= 100
     assert run.quarantined == 1  # the one invalid email is held back, not deleted
+    # the quarantined row is the only one missing from the output: it is no duplicate
+    assert (run.duplicates, run.dropped) == (0, 0)
+    assert run.clean_summary["rows_dropped"] == run.quarantined
     assert "Amt (INR)" in run.drift_text
     assert any("Amt (INR)" in note for note in run.patch_notes)
     assert run.replay_rows == 4
@@ -52,3 +55,5 @@ def test_demo_cli_json_summary(tmp_path):
     assert summary["status"] == "ok" and summary["command"] == "demo"
     assert Path(summary["outputs"]["recipe"]).is_file()
     assert "Schema drift detected" in out.stderr
+    assert "1 row(s) quarantined" in out.stderr
+    assert "duplicate row(s) dropped" not in out.stderr

cleanframe_engine-0.5.0/cleanframe/_version.py

@@ -1 +0,0 @@
-__version__ = "0.5.0"