Metadata-Version: 2.4
Name: cognite-data-quality
Version: 0.1.11
Summary: Data quality validation runner for SHACL rules in Cognite Data Fusion.
Project-URL: Documentation, https://cognite-data-quality-validation.readthedocs-hosted.com/en/latest/
Project-URL: Homepage, https://cognite-data-quality-validation.readthedocs-hosted.com/en/latest/
Author-email: Cognite <support@cognite.com>
License: Apache-2.0
License-File: LICENSE
Requires-Python: >=3.10
Requires-Dist: cognite-sdk
Requires-Dist: pandas>=2.1
Requires-Dist: pydantic>=2.0.0
Requires-Dist: pyshacl>=0.25.0
Requires-Dist: pyyaml
Requires-Dist: rdflib
Requires-Dist: toml; python_version >= '3.11'
Requires-Dist: tomli; python_version < '3.11'
Provides-Extra: dev
Requires-Dist: marko<3.0.0,>=2.1.0; extra == 'dev'
Requires-Dist: mypy; extra == 'dev'
Requires-Dist: packaging>=21.3; extra == 'dev'
Requires-Dist: pre-commit; extra == 'dev'
Requires-Dist: pytest; extra == 'dev'
Requires-Dist: pytest-cov; extra == 'dev'
Requires-Dist: ruff; extra == 'dev'
Requires-Dist: twine>=6.0.0; extra == 'dev'
Requires-Dist: typer>=0.9.0; extra == 'dev'
Description-Content-Type: text/markdown

# Cognite Data Quality

SHACL-based data quality validation for Cognite Data Fusion (CDF).

## Documentation

For full documentation, installation guides, deployment, and examples, see:

**[https://cognite-data-quality-validation.readthedocs-hosted.com/en/latest/](https://cognite-data-quality-validation.readthedocs-hosted.com/en/latest/)**

## Installation

```bash
pip install cognite-data-quality
```

## Quick Start

```python
from cognite_data_quality import DataModelConfig, run_validation, load_cognite_client_from_toml

client = load_cognite_client_from_toml("cog-sail.toml")

result = run_validation(
    client=client,
    rules_path="path/to/shacl_rules.ttl",
    rules_format="ttl",
    datamodel=DataModelConfig(space="my_space", external_id="MyModel", version="v1"),
    instance_space="my_space",
    limit=10,
)
print(result.conforms, result.instance_count, len(result.violations))
```

For YAML-based configuration, deployment, time series validation, and more, see the [documentation](https://cognite-data-quality-validation.readthedocs-hosted.com/en/latest/).
