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, or Postgres are compared where they are stored. The rules compile to SQL, and only counts and keys come back.
  • Many sources. CSV, Parquet, JSON, Arrow, Avro, and Excel files, Delta Lake and Iceberg tables, 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, 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.

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.12.1

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.12.1
File Size Uploaded
veridelta-0.12.1.tar.gz 640.5 kB Details

Built distribution (wheel)

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

Total release size: 769.8 kB

Release files / veridelta-0.12.1.tar.gz

Download URL veridelta-0.12.1.tar.gz
Size 640.5 kB
Tags Source
SHA-256 checksum
How to use checksums
bc106c8de391c5a9e16aae2dc8683fff26b66528bfabc297f573c44cb00c8fce
BLAKE2b-256 checksum
How to use checksums
361c7f2aaf3641911e37a242d22d9ac69418881702ec3e794dea716dccc99eec
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.12.1-py3-none-any.whl

Download URL veridelta-0.12.1-py3-none-any.whl
Size 129.3 kB
Tags Python 3
SHA-256 checksum
How to use checksums
5e6878ad2c78de43898b5c6b055cacb30f2a82b9e56b66be8215d2e9ed1f23f8
BLAKE2b-256 checksum
How to use checksums
ccf18bbef44e5a168253d141d6f349e30039683a8958ce2a135afacba5986318
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.12.1 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