datajudge


Namedatajudge JSON
Version 1.8.0 PyPI version JSON
download
home_page
Summarydatajudge allows to assess whether data from database complies with reference
upload_time2023-06-15 11:40:32
maintainer
docs_urlNone
author
requires_python>=3.8.0
license
keywords test databases validation
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls. 
            # 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
)
 ```

Raw data

            {
    "_id": null,
    "home_page": "",
    "name": "datajudge",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.8.0",
    "maintainer_email": "",
    "keywords": "test,databases,validation",
    "author": "",
    "author_email": "\"QuantCo, Inc.\" <noreply@quantco.com>",
    "download_url": "https://files.pythonhosted.org/packages/b0/f4/0774d027ccdb842ff3b7a3049b9467f54daf7d4590da678a8680e7aa7edb/datajudge-1.8.0.tar.gz",
    "platform": null,
    "description": "# datajudge\n\n[![CI](https://github.com/Quantco/datajudge/actions/workflows/ci.yaml/badge.svg)](https://github.com/Quantco/datajudge/actions/workflows/ci.yaml)\n[![Documentation Status](https://readthedocs.org/projects/datajudge/badge/?version=latest)](https://datajudge.readthedocs.io/en/latest/?badge=latest)\n[![Conda-forge](https://img.shields.io/conda/vn/conda-forge/datajudge?logoColor=white&logo=conda-forge)](https://anaconda.org/conda-forge/datajudge)\n[![PypiVersion](https://img.shields.io/pypi/v/datajudge.svg?logo=pypi&logoColor=white)](https://pypi.org/project/datajudge)\n[![codecov.io](https://codecov.io/github/QuantCo/datajudge/coverage.svg?branch=main)](https://codecov.io/github/QuantCo/datajudge?branch=main)\n\nExpress and test specifications against data from database.\n\n[Documentation](https://datajudge.readthedocs.io/en/latest/index.html)\n\n# Usage\n\n`datajudge` can either be installed via pypi with `pip install datajudge` or via conda-forge with `conda install datajudge -c conda-forge`.\n\nPlease refer to the [Getting Started](https://datajugde.readthedocs.io/en/latest/getting_started.html) section of our documentation for details.\n\nExpressing an expectations between different tables from a database may look as such:\n\n```python\nfrom datajudge import BetweenRequirement\n\ncompanies_between_req = BetweenRequirement.from_tables(\n    db_name1=\"example\",\n    table_name1=\"companies\",\n    db_name2=\"example\",\n    table_name2=\"companies_archive\",\n)\n\ncompanies_between_req.add_row_superset_constraint(\n    columns1=[\"name\"], columns2=[\"name\"], constant_max_missing_fraction=0\n)\n ```\n\n\n",
    "bugtrack_url": null,
    "license": "",
    "summary": "datajudge allows to assess  whether data from database complies with reference",
    "version": "1.8.0",
    "project_urls": {
        "Source": "https://github.com/quantco/datajudge"
    },
    "split_keywords": [
        "test",
        "databases",
        "validation"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "ee3dd4cb98312f543ac7974397b1b7f4d4b70cf7216e59ec2900370719c220cb",
                "md5": "677d2df251f28bd2010df051ca17bf7e",
                "sha256": "f36cad1004c94f941f8e3d255448724797a6624a34a8482710c4f4cd0cd88591"
            },
            "downloads": -1,
            "filename": "datajudge-1.8.0-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "677d2df251f28bd2010df051ca17bf7e",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.8.0",
            "size": 47448,
            "upload_time": "2023-06-15T11:40:31",
            "upload_time_iso_8601": "2023-06-15T11:40:31.221083Z",
            "url": "https://files.pythonhosted.org/packages/ee/3d/d4cb98312f543ac7974397b1b7f4d4b70cf7216e59ec2900370719c220cb/datajudge-1.8.0-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "b0f40774d027ccdb842ff3b7a3049b9467f54daf7d4590da678a8680e7aa7edb",
                "md5": "c85d332595547cd1cad0cdc28d133ddc",
                "sha256": "fff09de27a844723de8a7ae26c624412c2a91e652147118568a38781078a0d54"
            },
            "downloads": -1,
            "filename": "datajudge-1.8.0.tar.gz",
            "has_sig": false,
            "md5_digest": "c85d332595547cd1cad0cdc28d133ddc",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.8.0",
            "size": 380237,
            "upload_time": "2023-06-15T11:40:32",
            "upload_time_iso_8601": "2023-06-15T11:40:32.682247Z",
            "url": "https://files.pythonhosted.org/packages/b0/f4/0774d027ccdb842ff3b7a3049b9467f54daf7d4590da678a8680e7aa7edb/datajudge-1.8.0.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-06-15 11:40:32",
    "github": true,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "github_user": "quantco",
    "github_project": "datajudge",
    "travis_ci": false,
    "coveralls": false,
    "github_actions": true,
    "lcname": "datajudge"
}
Elapsed time: 0.07354s