https://github.com/quantco/datajudge

Assessing whether data from database complies with reference information.
https://github.com/quantco/datajudge

Last synced: 3 days ago
JSON representation

Assessing whether data from database complies with reference information.

• Host: GitHub
• URL: https://github.com/quantco/datajudge
• Owner: Quantco
• License: bsd-3-clause
• Created: 2022-04-20T07:00:13.000Z (over 2 years ago)
• Default Branch: main
• Last Pushed: 2024-12-23T09:11:02.000Z (11 days ago)
• Last Synced: 2024-12-23T10:20:29.639Z (11 days ago)
• Language: Python
• Homepage: https://datajudge.readthedocs.io
• Size: 1020 KB
• Stars: 42
• Watchers: 6
• Forks: 3
• Open Issues: 21
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
# datajudge

[![CI](https://github.com/Quantco/datajudge/actions/workflows/ci.yaml/badge.svg)](https://github.com/Quantco/datajudge/actions/workflows/ci.yaml)

[![Documentation Status](https://readthedocs.org/projects/datajudge/badge/?version=latest)](https://datajudge.readthedocs.io/en/latest/?badge=latest)

[![Conda-forge](https://img.shields.io/conda/vn/conda-forge/datajudge?logoColor=white&logo=conda-forge)](https://anaconda.org/conda-forge/datajudge)

[![PypiVersion](https://img.shields.io/pypi/v/datajudge.svg?logo=pypi&logoColor=white)](https://pypi.org/project/datajudge)

[![codecov.io](https://codecov.io/github/QuantCo/datajudge/coverage.svg?branch=main)](https://codecov.io/github/QuantCo/datajudge?branch=main)

Express and test specifications against data from database.

[Documentation](https://datajudge.readthedocs.io/en/latest/index.html)

# Usage

`datajudge` can either be installed via pypi with `pip install datajudge` or via conda-forge with `conda install datajudge -c conda-forge`.

Please refer to the [Getting Started](https://datajugde.readthedocs.io/en/latest/getting_started.html) section of our documentation for details.

Expressing an expectations between different tables from a database may look as such:

```python

from datajudge import BetweenRequirement

companies_between_req = BetweenRequirement.from_tables(

    db_name1="example",

    table_name1="companies",

    db_name2="example",

    table_name2="companies_archive",

)

companies_between_req.add_row_superset_constraint(

    columns1=["name"], columns2=["name"], constant_max_missing_fraction=0

)

```