Skip to content

robolyst/recx

Repository files navigation



Lightweight reconciliation tests for DataFrames

CI Build PyPI version PyPI license Project Status: Active

Use Rec to compare two DataFrames (baseline vs candidate) with per-column checks (equality, absolute / relative tolerance, regex-driven selection) and clear summaries of failures.

Features

  • Declarative column mapping
  • Built-in checks: equality, absolute tolerance, relative tolerance
  • Index integrity checks (missing / extra index values)
  • Regex column selection (regex=True on checks)
  • Compact textual summary
  • Extensible: implement custom checks by subclassing ColumnCheck

Install

With pip:

pip install recx

with uv:

uv add recx

Quick Example

import pandas as pd
from recx import Rec, EqualCheck, AbsTolCheck

baseline = pd.DataFrame({
    "price": [100.00, 200.00, 300.00],
    "status": ["active", "inactive", "active"]
})

candidate = pd.DataFrame({
    "price": [100.00, 200.00, 301.00],
    "status": ["active", "inactive", "active"]
})

rec = Rec(columns={
    "price": AbsTolCheck(tol=0.01),
    "status": EqualCheck(),
})

result = rec.run(baseline, candidate)
result.summary()

Feel free to open issues or PRs with suggestions or improvements.

About

Lightweight reconciliation tests for DataFrames

Resources

License

Stars

Watchers

Forks

Packages

 
 
 

Contributors