Metadata-Version: 2.3
Name: koality
Version: 0.1.0
Summary: Library for data checks and data quality monitoring based on duckdb.
Keywords: data-quality,data-validation,duckdb,data-checks,data-monitoring,etl,data-pipeline,data-engineering,data-testing,data-profiling,data-observability,sql,analytics,data-warehouse,cli,yaml,pydantic
Author: Team PiT @ Otto Group data.works GmbH, Norbert Maager, Benjamin Gutzmann, Michel Lentzler
Author-email: Benjamin Gutzmann <benjamin.gutzmann@pm.me>
License: # MIT License
         
         Copyright (c) 2025 koality maintainers
         
         Permission is hereby granted, free of charge, to any person obtaining a copy
         of this software and associated documentation files (the "Software"), to deal
         in the Software without restriction, including without limitation the rights
         to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
         copies of the Software, and to permit persons to whom the Software is
         furnished to do so, subject to the following conditions:
         
         The above copyright notice and this permission notice shall be included in all
         copies or substantial portions of the Software.
         
         THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
         IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
         FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
         AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
         LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
         OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
         SOFTWARE.
Classifier: Development Status :: 4 - Beta
Classifier: Environment :: Console
Classifier: Intended Audience :: Developers
Classifier: Intended Audience :: Science/Research
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Classifier: Programming Language :: Python :: 3.14
Classifier: Programming Language :: SQL
Classifier: Topic :: Database
Classifier: Topic :: Scientific/Engineering
Classifier: Topic :: Software Development :: Quality Assurance
Classifier: Topic :: Software Development :: Testing
Classifier: Typing :: Typed
Requires-Dist: click>=8.1.3
Requires-Dist: duckdb>=1.4.2
Requires-Dist: pydantic>=2.12.5
Requires-Dist: pydantic-yaml>=1.6.0
Requires-Dist: pyyaml>=6.0
Requires-Python: >=3.12
Description-Content-Type: text/markdown

<p align="center">
  <img src="docs/assets/logo.png" alt="Koality Logo" width="400">
</p>

<p align="center">
  <strong>Data Quality Monitoring powered by DuckDB</strong>
</p>

<p align="center">
  <a href="https://github.com/ottogroup/koality/actions/workflows/release.yml"><img src="https://github.com/ottogroup/koality/workflows/release/badge.svg" alt="Build Status"></a>
  <a href="https://github.com/ottogroup/koality/actions/workflows/pages/pages-build-deployment"><img src="https://github.com/ottogroup/koality/actions/workflows/pages/pages-build-deployment/badge.svg" alt="Pages Deployment"></a>
  <a href="https://pypi.org/project/koality/"><img src="https://img.shields.io/pypi/v/koality.svg" alt="PyPI version"></a>
  <a href="https://pypi.org/project/koality/"><img src="https://img.shields.io/pypi/pyversions/koality.svg" alt="Python versions"></a>
  <a href="https://pepy.tech/project/koality"><img src="https://static.pepy.tech/personalized-badge/koality?period=month&units=international_system&left_color=grey&right_color=blue&left_text=PyPI%20downloads/month" alt="PyPI downloads"></a>
  <a href="https://github.com/ottogroup/koality/blob/main/LICENSE.md"><img src="https://img.shields.io/github/license/ottogroup/koality" alt="License"></a>
</p>

---

**Koality** is a Python library for data quality monitoring (DQM) using [DuckDB](https://duckdb.org/). It provides configurable checks that validate data in tables and can persist results to database tables for monitoring and alerting.

We would like to thank [Norbert Maager](https://github.com/norbertmaager) who is the original inventor of Koality.

**Warning**

This library is a work in progress!

Breaking changes should be expected until a 1.0 release, so version pinning is recommended.

## Documentation

For comprehensive documentation, visit the [Koality Documentation](https://ottogroup.github.io/koality/).

## Core Features

- **Configurable Checks**: Define data quality checks via simple YAML configuration files
- **DuckDB-Powered**: Fast, in-process analytics with support for external databases (BigQuery, Postgres, etc.)
- **Multiple Check Types**: Null ratios, regex matching, value sets, duplicates, counts, match rates, outlier detection, and more
- **Flexible Filtering**: Dynamic filtering system with column/value pairs for targeted checks
- **Result Persistence**: Store check results in database tables for historical tracking
- **CLI Tool**: Easy-to-use command-line interface for running checks
- **Threshold Validation**: Compare check results against configurable lower/upper bounds

## Available Checks

| Check Type | Description |
|------------|-------------|
| `NullRatioCheck` | Share of NULL values in a column |
| `RegexMatchCheck` | Share of values matching a regex pattern |
| `ValuesInSetCheck` | Share of values matching a predefined set |
| `RollingValuesInSetCheck` | Values in set over a rolling time window |
| `DuplicateCheck` | Number of duplicate values in a column |
| `CountCheck` | Row count or distinct value count |
| `MatchRateCheck` | Match rate between two tables after joining |
| `RelCountChangeCheck` | Relative count change vs. historical average |
| `IqrOutlierCheck` | Detect outliers using interquartile range |
| `OccurrenceCheck` | Check value occurrence frequency |

## Installation

```bash
pip install koality
```

Or add to your `pyproject.toml`:

```toml
[project]
dependencies = [
    "koality>=0.1.0",
]
```

## Quick Start

### 1. Create a configuration file

```yaml
# koality_config.yaml
name: My Data Quality Checks

defaults:
  date_filter_column: date
  date: yesterday
  result_table: my_project.dqm.results
  persist_results: true
  log_path: dqm_failures.txt

check_bundles:
  - name: null_ratio_checks
    defaults:
      check_type: NullRatioCheck
      table: my_project.dataset.orders
      lower_threshold: 0
      upper_threshold: 0.05
    checks:
      - check_column: customer_id
      - check_column: order_date
      - check_column: total_amount
```

### 2. Run checks via CLI

```bash
koality --config_path koality_config.yaml
```

### 3. Review results

Results are persisted to your configured result table and failures are logged to the specified log path.

## Configuration Hierarchy

Koality uses a hierarchical configuration system where more specific settings override general ones:

1. **`defaults`**: Base settings for all checks (result table, persistence, filters)
2. **`check_bundles.defaults`**: Bundle-level defaults (check type, table, thresholds)
3. **`checks`**: Individual check configurations (specific columns, custom thresholds)

## Filter System

Apply dynamic filters to check specific data subsets:

```yaml
defaults:
  date_filter_column: created_at
  date: yesterday
  shop_id_filter_column: shop_id
  shop_id: SHOP01
```

## Time Magic

Koality supports relative date expressions:

- `today`, `yesterday`, `tomorrow`
- `today-2`, `today+3` (offset by days)

## Contributing

Contributions are welcome! Please feel free to submit issues and pull requests on [GitHub](https://github.com/ottogroup/koality).

## License

This project is licensed under the MIT License - see the [LICENSE.md](LICENSE.md) file for details.