Metadata-Version: 2.4
Name: dqf
Version: 0.1.2
Summary: Data Quality Framework — composable, pipeline-based data quality validation for analytical datasets
Project-URL: Repository, https://github.com/Mirkiux/dqf
Project-URL: Documentation, https://mirkiux.github.io/dqf
Project-URL: Changelog, https://github.com/Mirkiux/dqf/blob/main/CHANGELOG.md
Project-URL: Bug Tracker, https://github.com/Mirkiux/dqf/issues
Author: Mirko
License:                                  Apache License
                                   Version 2.0, January 2004
                                http://www.apache.org/licenses/
        
           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
        
           1. Definitions.
        
              "License" shall mean the terms and conditions for use, reproduction,
              and distribution as defined by Sections 1 through 9 of this document.
        
              "Licensor" shall mean the copyright owner or entity authorized by
              the copyright owner that is granting the License.
        
              "Legal Entity" shall mean the union of the acting entity and all
              other entities that control, are controlled by, or are under common
              control with that entity. For the purposes of this definition,
              "control" means (i) the power, direct or indirect, to cause the
              direction or management of such entity, whether by contract or
              otherwise, or (ii) ownership of fifty percent (50%) or more of the
              outstanding shares, or (iii) beneficial ownership of such entity.
        
              "You" (or "Your") shall mean an individual or Legal Entity
              exercising permissions granted by this License.
        
              "Source" form shall mean the preferred form for making modifications,
              including but not limited to software source code, documentation
              source, and configuration files.
        
              "Object" form shall mean any form resulting from mechanical
              transformation or translation of a Source form, including but
              not limited to compiled object code, generated documentation,
              and conversions to other media types.
        
              "Work" shall mean the work of authorship made available under
              the License, as indicated by a copyright notice that is included in
              or attached to the work (an example is provided in the Appendix below).
        
              "Derivative Works" shall mean any work, whether in Source or Object
              form, that is based on (or derived from) the Work and for which the
              editorial revisions, annotations, elaborations, or other transformations
              represent, as a whole, an original work of authorship. For the purposes
              of this License, Derivative Works shall not include works that remain
              separable from, or merely link (or bind by name) to the interfaces of,
              the Work and Derivative Works thereof.
        
              "Contribution" shall mean, as defined by Section 5, any work of
              authorship, including the original version of the Work and any
              modifications or additions to that Work or Derivative Works of the Work,
              that is intentionally submitted to the Licensor for inclusion in the Work
              by the copyright owner or by an individual or Legal Entity authorized to
              submit on behalf of the copyright owner. For the purposes of this
              definition, "submitted" means any form of electronic, verbal, or written
              communication sent to the Licensor or its representatives, including but
              not limited to communication on electronic mailing lists, source code
              control systems, and issue tracking systems that are managed by, or on
              behalf of, the Licensor for the purpose of discussing and improving the
              Work, but excluding communication that is conspicuously marked or
              otherwise designated in writing by the copyright owner as "Not a
              Contribution."
        
              "Contributor" shall mean Licensor and any Legal Entity on behalf of
              whom a Contribution has been received by the Licensor and has been
              included in the Work.
        
           2. Grant of Copyright License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              copyright license to reproduce, prepare Derivative Works of,
              publicly display, publicly perform, sublicense, and distribute the
              Work and such Derivative Works in Source or Object form.
        
           3. Grant of Patent License. Subject to the terms and conditions of
              this License, each Contributor hereby grants to You a perpetual,
              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
              (except as stated in this section) patent license to make, have made,
              use, offer to sell, sell, import, and otherwise transfer the Work,
              where such license applies only to those patent contributions made by
              that Contributor that are necessarily infringed by their Contribution(s)
              alone or by the combination of their Contribution(s) with the Work to
              which such Contribution(s) was submitted. If You institute patent
              litigation against any entity (including a cross-claim or counterclaim
              in a lawsuit) alleging that the Work or any Contribution embodied within
              the Work constitutes direct or contributory patent infringement, then
              any patent licenses granted to You under this License for that Work
              shall terminate as of the date such litigation is filed.
        
           4. Redistribution. You may reproduce and distribute copies of the
              Work or Derivative Works thereof in any medium, with or without
              modifications, and in Source or Object form, provided that You
              meet the following conditions:
        
              (a) You must give any other recipients of the Work or Derivative
                  Works a copy of this License; and
        
              (b) You must cause any modified files to carry prominent notices
                  stating that You changed the files; and
        
              (c) You must retain, in the Source form of any Derivative Works
                  that You distribute, all copyright, patent, trademark, and
                  attribution notices from the Source form of the Work,
                  excluding those notices that do not pertain to any part of
                  the Derivative Works; and
        
              (d) If the Work includes a "NOTICE" text file as part of its
                  distribution, You must include a readable copy of the
                  attribution notices contained within such NOTICE file, in
                  at least one of the following places: within a NOTICE text
                  file distributed as part of the Derivative Works; within
                  the Source form or documentation, if provided along with the
                  Derivative Works; or, within a display generated by the
                  Derivative Works, if and wherever such third-party notices
                  normally appear. The contents of the NOTICE file are for
                  informational purposes only and do not modify the License.
                  You may add Your own attribution notices within Derivative
                  Works that You distribute, alongside or in addition to the
                  NOTICE text from the Work, provided that such additional
                  attribution notices cannot be construed as modifying the License.
        
              You may add Your own license statement for Your modifications and
              may provide additional grant of rights to use, copy, modify, merge,
              publish, distribute, sublicense, and/or sell copies of the
              Derivative Works, as You choose.
        
           5. Submission of Contributions. Unless You explicitly state otherwise,
              any Contribution intentionally submitted for inclusion in the Work
              by You to the Licensor shall be under the terms and conditions of
              this License, without any additional terms or conditions.
              Notwithstanding the above, nothing herein shall supersede or modify
              the terms of any separate license agreement you may have executed
              with Licensor regarding such Contributions.
        
           6. Trademarks. This License does not grant permission to use the trade
              names, trademarks, service marks, or product names of the Licensor,
              except as required for reasonable and customary use in describing the
              origin of the Work and reproducing the content of the NOTICE file.
        
           7. Disclaimer of Warranty. Unless required by applicable law or
              agreed to in writing, Licensor provides the Work (and each
              Contributor provides its Contributions) on an "AS IS" BASIS,
              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
              implied, including, without limitation, any warranties or conditions
              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
              PARTICULAR PURPOSE. You are solely responsible for determining the
              appropriateness of using or reproducing the Work and assume any
              risks associated with Your exercise of permissions under this License.
        
           8. Limitation of Liability. In no event and under no legal theory,
              whether in tort (including negligence), contract, or otherwise,
              unless required by applicable law (such as deliberate and grossly
              negligent acts) or agreed to in writing, shall any Contributor be
              liable to You for damages, including any direct, indirect, special,
              incidental, or exemplary damages of any character arising as a
              result of this License or out of the use or inability to use the
              Work (including but not limited to damages for loss of goodwill,
              work stoppage, computer failure or malfunction, or all other
              commercial damages or losses), even if such Contributor has been
              advised of the possibility of such damages.
        
           9. Accepting Warranty or Liability. While redistributing the Work or
              Derivative Works thereof, You may choose to offer, and charge a fee
              for, acceptance of support, warranty, indemnity, or other liability
              obligations and/or rights consistent with this License. However, in
              accepting such obligations, You may offer such obligations only on
              Your own behalf and on Your sole responsibility, not on behalf of
              any other Contributor, and only if You agree to indemnify, defend,
              and hold each Contributor harmless for any liability incurred by,
              or claims asserted against, such Contributor by reason of your
              accepting any warranty or additional liability.
        
           END OF TERMS AND CONDITIONS
        
           Copyright 2026 Mirko
        
           Licensed under the Apache License, Version 2.0 (the "License");
           you may not use this file except in compliance with the License.
           You may obtain a copy of the License at
        
               http://www.apache.org/licenses/LICENSE-2.0
        
           Unless required by applicable law or agreed to in writing, software
           distributed under the License is distributed on an "AS IS" BASIS,
           WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
           See the License for the specific language governing permissions and
           limitations under the License.
License-File: LICENSE
License-File: NOTICE
Keywords: data engineering,data quality,pandas,pipeline,pyspark,validation
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Requires-Dist: matplotlib>=3.7
Requires-Dist: numpy>=1.24
Requires-Dist: pandas>=2.0
Requires-Dist: scipy>=1.10
Requires-Dist: sqlalchemy>=2.0
Provides-Extra: databricks
Requires-Dist: databricks-sql-connector>=3.0; extra == 'databricks'
Provides-Extra: dev
Requires-Dist: build>=1.0; extra == 'dev'
Requires-Dist: hatch>=1.9; extra == 'dev'
Requires-Dist: mypy>=1.0; extra == 'dev'
Requires-Dist: pytest-cov>=4.0; extra == 'dev'
Requires-Dist: pytest>=7.0; extra == 'dev'
Requires-Dist: ruff>=0.4; extra == 'dev'
Requires-Dist: twine>=5.0; extra == 'dev'
Provides-Extra: docs
Requires-Dist: mkdocs-material>=9.5; extra == 'docs'
Requires-Dist: mkdocs>=1.6; extra == 'docs'
Requires-Dist: mkdocstrings[python]>=0.25; extra == 'docs'
Provides-Extra: spark
Requires-Dist: pyspark>=3.4; extra == 'spark'
Description-Content-Type: text/markdown

# dqf — Data Quality Framework

A composable, pipeline-based Python library for data quality validation of analytical datasets.

`dqf` is designed for data engineers and data scientists working with enterprise data warehouses and lakes. It validates ML features, analytical datasets, and target variables at any scale — connecting directly to Databricks, BigQuery, Snowflake, PostgreSQL, Spark, or any SQLAlchemy-compatible engine.

```
pip install dqf
```

---

## Why dqf?

| Feature | dqf |
|---|---|
| Universe-anchored metrics | All null rates, coverage, and drift statistics are measured against the **universe population**, not the raw dataset row count |
| SQL-first | You write the SQL; dqf executes it and validates results |
| Composable pipelines | Mix and match cross-sectional and longitudinal checks exactly like sklearn pipelines |
| Batteries-included resolver | `build_default_resolver()` dispatches the right checks to each variable type automatically |
| Multi-engine | Databricks, SQLAlchemy (Snowflake, BigQuery, Postgres, …), Spark, or in-memory `MockAdapter` |
| Zero training | Thresholds are explicit business decisions, not learned parameters |

---

## Quick start

### Cross-sectional validation

```python
import pandas as pd
import dqf

adapter = dqf.MockAdapter({
    "SELECT id FROM entities": pd.DataFrame({"id": range(1, 101)}),
    "SELECT id, age, segment FROM features": pd.DataFrame({
        "id": range(1, 101),
        "age": [25 + i % 50 for i in range(100)],
        "segment": ["A" if i % 2 == 0 else "B" for i in range(100)],
    }),
})

universe = dqf.UniverseDataset(
    sql="SELECT id FROM entities",
    primary_key=["id"],
    adapter=adapter,
)

dataset = dqf.VariablesDataset(
    sql="SELECT id, age, segment FROM features",
    primary_key=["id"],
    universe=universe,
    join_keys={"id": "id"},
    adapter=adapter,
    variables=[
        dqf.Variable(name="age", dtype=dqf.DataType.NUMERIC_CONTINUOUS),
        dqf.Variable(name="segment", dtype=dqf.DataType.CATEGORICAL),
    ],
)

resolver = dqf.build_default_resolver(null_threshold=0.05)
report = dataset.run_validation(resolver, dataset_name="my_features")

print(report.overall_status.value)   # PASSED / FAILED
print(report.to_dataframe())
```

### Longitudinal validation (time series)

Pass `time_field` to `build_default_resolver` to enable trend detection and structural break checks for numeric features, and drift checks for targets:

```python
resolver = dqf.build_default_resolver(
    time_field="event_date",
    period="month",
    null_threshold=0.05,
)
report = dataset.run_validation(resolver, dataset_name="monthly_features")
```

### Custom rules on top of the defaults

```python
from dqf.checks.cross_sectional.range_check import RangeCheck
from dqf.checks.pipeline import CheckPipeline

resolver = dqf.build_default_resolver(null_threshold=0.05)

# Override the default NUMERIC_CONTINUOUS rule for credit_score
resolver.register(
    predicate=lambda v: v.name == "credit_score",
    pipeline_factory=lambda: CheckPipeline([
        ("range", RangeCheck(min_value=300, max_value=850, severity=dqf.Severity.FAILURE))
    ]),
    priority=50,  # higher than the default priority 15
)
```

See the [examples/](examples/) directory for complete runnable scripts.

---

## Core concepts

### Universe dataset

The population against which all metrics are measured. Every quality statistic — null rate, coverage, drift — is expressed as a fraction of the universe size, not the raw dataset row count.

```python
universe = dqf.UniverseDataset(
    sql="SELECT customer_id FROM customers",
    primary_key=["customer_id"],
    adapter=adapter,
)
```

### Variables dataset

The dataset under analysis. Always left-joined to the universe, so missing rows (coverage gaps) are visible as nulls rather than silently excluded.

```python
dataset = dqf.VariablesDataset(
    sql="SELECT customer_id, age, income FROM features",
    primary_key=["customer_id"],
    universe=universe,
    join_keys={"customer_id": "customer_id"},
    adapter=adapter,
    variables=[
        dqf.Variable(name="age", dtype=dqf.DataType.NUMERIC_CONTINUOUS),
        dqf.Variable(name="income", dtype=dqf.DataType.NUMERIC_CONTINUOUS),
    ],
)
```

### Variable

A descriptor for a single column. Carries semantic type (`DataType`), role (`VariableRole`), and accumulates check results over its lifetime.

```python
dqf.Variable(
    name="is_fraud",
    dtype=dqf.DataType.BOOLEAN,
    role=dqf.VariableRole.TARGET,
)
```

### CheckSuiteResolver

A priority-ordered registry that maps each `Variable` to a `CheckPipeline`. The first matching rule wins.

```python
resolver = dqf.CheckSuiteResolver()
resolver.register(
    predicate=lambda v: v.dtype == dqf.DataType.CATEGORICAL,
    pipeline_factory=lambda: my_categorical_pipeline(),
    priority=10,
)
```

### CheckPipeline

An ordered list of `(name, check)` pairs — analogous to sklearn's `Pipeline`. Steps run sequentially; a `FAILURE`-severity failure marks the variable as failed.

```python
from dqf.checks.pipeline import CheckPipeline
from dqf.checks.cross_sectional.null_rate import NullRateCheck
from dqf.checks.cross_sectional.cardinality_check import CardinalityCheck

pipeline = CheckPipeline([
    ("null_rate", NullRateCheck(threshold=0.05, severity=dqf.Severity.FAILURE)),
    ("cardinality", CardinalityCheck(max_cardinality=20, severity=dqf.Severity.WARNING)),
])
```

### ValidationReport

The top-level output of `run_validation`. Provides per-variable check results, overall status, and HTML rendering.

```python
report.overall_status        # ValidationStatus.PASSED / FAILED
report.universe_size         # int
report.variable_results      # dict[str, list[CheckResult]]
report.to_dataframe()        # flat pandas DataFrame, one row per check
report.failed_variables()    # list of variable names with FAILURE results
report.render()              # HTML string with embedded plots
```

---

## Data types and roles

### `DataType`

| Value | Meaning |
|---|---|
| `NUMERIC_CONTINUOUS` | Real-valued numeric (float, double) |
| `NUMERIC_DISCRETE` | Integer-valued numeric with bounded cardinality |
| `CATEGORICAL` | String or low-cardinality categorical |
| `BOOLEAN` | Binary 0/1 or True/False |
| `DATETIME` | Date or timestamp |
| `TEXT` | Free-form text |
| `IDENTIFIER` | Primary key or join key column |

### `VariableRole`

| Value | Meaning |
|---|---|
| `FEATURE` | Input feature (default) |
| `TARGET` | Prediction target — drift checks applied |
| `IDENTIFIER` | Key column — not-null enforced |
| `AUXILIARY` | Metadata column — not validated |

---

## Built-in checks

### Cross-sectional

| Class | Check name | Description |
|---|---|---|
| `NullRateCheck` | `null_rate` | Fails/warns when null fraction exceeds threshold |
| `NotNullCheck` | `not_null` | Fails when any null is present |
| `CardinalityCheck` | `cardinality` | Warns when distinct value count exceeds limit |
| `OutlierCheck` | `outlier` | Flags outliers via Tukey IQR method |
| `RangeCheck` | `range` | Fails when any value is outside [min, max] |
| `UniquenessCheck` | `uniqueness` | Fails when duplicate values appear |
| `AllowedValuesCheck` | `allowed_values` | Fails when values outside an allowed set appear |
| `RegexPatternCheck` | `regex_pattern` | Fails when values don't match a regex pattern |
| `ReferentialIntegrityCheck` | `referential_integrity` | Fails when values are missing from a reference set |

### Longitudinal (time series)

| Class | Check name | Description |
|---|---|---|
| `TrendCheck` | `trend` | Detects monotonic trend via Kendall's tau |
| `StructuralBreakCheck` | `structural_break` | Detects abrupt level shifts via CUSUM |
| `ProportionDriftCheck` | `proportion_drift` | Sequential Z-test for binary target drift |
| `KSDriftCheck` | `ks_drift` | Sequential KS test for continuous distribution drift |
| `ChiSquaredDriftCheck` | `chisquared_drift` | Sequential chi-squared test for categorical drift |
| `DistributionDriftCheck` | `distribution_drift` | General distribution drift (PSI) |
| `SeasonalityCheck` | `seasonality` | Detects seasonal patterns |
| `ConceptDriftCheck` | `concept_drift` | Detects concept drift using sliding window comparison |

---

## Default resolver — priority table

`build_default_resolver()` registers rules in this priority order:

| Priority | Condition | Pipeline |
|---|---|---|
| 30 | `role == IDENTIFIER` | `not_null` (FAILURE) |
| 25 | `role == TARGET`, `dtype == BOOLEAN` | `not_null` + `proportion_drift` |
| 24 | `role == TARGET`, `dtype in (CATEGORICAL, NUMERIC_DISCRETE)` | `not_null` + `chisquared_drift` |
| 23 | `role == TARGET`, `dtype == NUMERIC_CONTINUOUS` | `not_null` + `ks_drift` |
| 20 | `role == TARGET` (catch-all) | `not_null` |
| 15 | `dtype == NUMERIC_CONTINUOUS` | `null_rate` + `trend` + `structural_break` |
| 10 | `dtype == NUMERIC_DISCRETE` | `null_rate` + `cardinality` + `outlier` (+ `chisquared_drift` if time) |
| 7 | `dtype == CATEGORICAL` | `null_rate` + `cardinality` |
| 5 | `dtype == BOOLEAN` | `null_rate` |
| 0 | catch-all | `null_rate` (WARNING) |

Longitudinal checks are omitted when `time_field=None` (the default).

---

## Adapters

| Adapter | Use case |
|---|---|
| `SQLAlchemyAdapter` | PostgreSQL, Snowflake, BigQuery, Oracle, any SQLAlchemy engine |
| `DatabricksAdapter` | Databricks SQL warehouses |
| `SparkAdapter` | Apache Spark (local or cluster) |
| `MockAdapter` | Unit tests and examples — maps SQL strings to DataFrames |

```python
# SQLAlchemy (e.g. PostgreSQL)
from sqlalchemy import create_engine
adapter = dqf.SQLAlchemyAdapter(create_engine("postgresql+psycopg2://..."))

# Databricks
adapter = dqf.DatabricksAdapter(
    server_hostname="...", http_path="...", access_token="..."
)

# Spark
from pyspark.sql import SparkSession
spark = SparkSession.builder.getOrCreate()
adapter = dqf.SparkAdapter(spark)

# Mock (tests)
adapter = dqf.MockAdapter({"SELECT id FROM t": pd.DataFrame({"id": [1, 2, 3]})})
```

---

## Installation

```
pip install dqf
```

Optional extras:

```
pip install "dqf[spark]"       # PySpark support
pip install "dqf[databricks]"  # Databricks SQL connector
pip install "dqf[docs]"        # MkDocs + mkdocstrings for building the docs
```

Requires Python 3.10+.

---

## Examples

| File | Description |
|---|---|
| [examples/01_basic_validation.py](examples/01_basic_validation.py) | Cross-sectional validation with `build_default_resolver` |
| [examples/02_longitudinal_validation.py](examples/02_longitudinal_validation.py) | Trend + structural break checks with a time dimension |
| [examples/03_custom_resolver.py](examples/03_custom_resolver.py) | Domain-specific range checks alongside the default suite |
| [examples/04_target_drift.py](examples/04_target_drift.py) | Binary target drift detection (fraud rate shift) |

---

## Development

```bash
git clone https://github.com/Mirkiux/dqf
cd dqf
pip install -e ".[dev]"
pytest
ruff check src tests
mypy src
```

---

## License

Apache License 2.0 — see [LICENSE](LICENSE).
