Skip to main content

Veridelta

CI Pipeline codecov PyPI version License

Veridelta compares two datasets on their primary keys and reports every row that differs once the rules you declare are applied. Use it to verify a system migration, a model retrain, or a pipeline change.

It runs on Polars. Read the documentation.

Features

  • Declared rules. Tolerances, null sentinels, regular expressions, value maps, date parsing, casts, and fuzzy text matching apply in nine fixed stages. Nothing is forgiven unless a rule says so, and strict_types fails a column whose type drifts.
  • The same verdict in the warehouse. Two tables in Snowflake, Databricks, BigQuery, Postgres, or DuckDB are compared where they are stored. The rules compile to SQL, and only counts and keys come back. Pushdown lists the exceptions.
  • Many sources. CSV, Parquet, JSON, Arrow, Avro, and Excel files, Delta Lake and Iceberg tables, DuckDB files and MotherDuck databases, and Postgres, MySQL, SQL Server, Oracle, SQLite, and other databases. Files and tables are scanned lazily where Polars can.
  • Built for CI. Exit codes, a JSON summary, a standalone HTML report, a Markdown summary for pull requests, OpenTelemetry metrics, and files of the rows that differ. A GitHub Action and a GitLab CI template post the summary on each pull request.
  • Checks before a run. veridelta validate reports what would stop a run without reading any rows, and a JSON Schema gives editors completion for configuration files.

Install

uv add veridelta                # or: pip install veridelta
uv add 'veridelta[snowflake]'   # extras: snowflake, databricks, bigquery, delta, iceberg, database, duckdb, excel, fuzzy, all

Quick start

In Python, DiffEngine compares two LazyFrames:

import polars as pl
from veridelta import DiffConfig, DiffEngine, DiffRule

result = DiffEngine(
    DiffConfig(
        primary_keys=["user_id"],
        rules=[DiffRule(pattern="^AMT_.*", absolute_tolerance=0.05)],
    ),
    pl.scan_parquet("legacy.parquet"),
    pl.scan_parquet("modern.parquet"),
).run()

if not result.summary.is_match:
    raise SystemExit(f"{result.summary.changed_count} rows differ")

The same comparison as a YAML file, for the CLI and CI:

# veridelta.yaml
primary_keys: ["transaction_id"]
source:
  path: "legacy.parquet"
  format: "parquet"
target:
  path: "modern.parquet"
  format: "parquet"
rules:
  - column_names: ["grand_total"]
    relative_tolerance: 0.01
  - column_names: ["contact_number"]
    regex_replace: {"[^0-9]": ""}

validate checks the file without reading any rows, and run compares the datasets:

veridelta validate -c veridelta.yaml
veridelta run -c veridelta.yaml

Documentation

  • Tutorials: five notebooks, from a first comparison in Python to a CI pipeline.
  • User guide: configuration, sources, rules, pushdown, results, and the command line.
  • CI integrations: the GitHub Action and the GitLab CI template.
  • API reference: the public Python interface.
  • Roadmap: work that is not built yet.

Accessibility

ACCESSIBILITY.md states what Veridelta aims for, the barriers known today, and how to report one.

Contributing

See CONTRIBUTING.md for the development setup and the checks a change must pass.

License

Apache 2.0.

Metadata

Release files for veridelta 0.14.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for veridelta 0.14.0
File Size Uploaded
veridelta-0.14.0.tar.gz 733.9 kB Details

Built distribution (wheel)

Table of built distributions (wheels) for veridelta 0.14.0
File Interpreter ABI Platform
veridelta-0.14.0-py3-none-any.whl Python 3 none any Details

Total release size: 854.0 kB

Release files / veridelta-0.14.0.tar.gz

Download URL veridelta-0.14.0.tar.gz
Size 733.9 kB
Tags Source
SHA-256 checksum
How to use checksums
533352efec4dc0bb223033e3542b1281da1716af9416ee2e7a965014d3a8145e
BLAKE2b-256 checksum
How to use checksums
ea2c8d8a6df16453ea9c95e69ac220d5c0a0d19202dac12d8b5325f08ea5d0f5
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release files / veridelta-0.14.0-py3-none-any.whl

Download URL veridelta-0.14.0-py3-none-any.whl
Size 120.1 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4692c02b61b01a25697ba2b411b81d0aaded33978c72bba4c94d9bd0b9dbfeeb
BLAKE2b-256 checksum
How to use checksums
639a8e6d66a72cfa7eb06935e465a111856c4c202caa969985639c4047942398
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via uv/0.12.23 {"installer":{"name":"uv","version":"0.12.23","subcommand":["publish"]},"python":null,"implementation":{"name":null,"version":null},"distro":{"name":"Ubuntu","version":"24.04","id":"noble","libc":null},"system":{"name":null,"release":null},"cpu":null,"openssl_version":null,"setuptools_version":null,"rustc_version":null,"ci":true}

Release history Release notifications | RSS feed

This release

0.14.0 This release

2 release files

0.10.0

2 release files

0.9.1

2 release files

0.9.0

2 release files

0.8.0

2 release files

0.7.0

2 release files

0.6.0

2 release files

0.5.1

2 release files

0.5.0

2 release files

0.4.0

2 release files

0.3.0

2 release files

0.2.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page