Metadata-Version: 2.1
Name: qprofiler
Version: 0.2.3
Summary: profile tabular datasets, manage automatic validation for new datasets, automatic handling for quality issues.
Home-page: https://github.com/Ezzaldin97/dprofiler
License: MIT
Author: Ezzaldin97
Author-email: kingtal632@yahoo.com
Requires-Python: >=3.10,<4.0
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Requires-Dist: colorama (>=0.4.4,<0.5.0)
Requires-Dist: pathlib (>=1.0,<2.0)
Requires-Dist: polars[all] (>=0.19.0,<0.20.0)
Requires-Dist: pyyaml (>=6.0.1,<7.0.0)
Requires-Dist: ruamel-yaml (>=0.17.32,<0.18.0)
Requires-Dist: typing-extensions (>=4.7.0,<5.0.0)
Project-URL: Repository, https://github.com/Ezzaldin97/dprofiler
Description-Content-Type: text/markdown

[![interrogate](./badges/interrogate_badge.svg)]

# qprofiler

**qprofiler** is a Python package that provides an intelligent way to create a data quality profile for your development(train) dataset(s) and save it as a reference to use in creating quality check tests and automatic handling cases for production(test) datasets.

## Table of Contents

- [Installation](#installation)
- [Dependencies](#dependencies)
- [Usage](#usage)
- [Contributing](#contributing)
- [Licence](#licence)

## Installation
The source code is currently hosted on GitHub at:
[dprofiler-github](https://github.com/Ezzaldin97/dprofiler)

Binary installers for the latest released version are available at the [PyPi](https://pypi.org/)
```bash
# PyPi
pip install qprofiler
```
## Dependencies

- Polars(>=0.19.0 <0.20.0)
- PyYAML(>=6.0.1 <7.0.0)
- Pathlib(>=1.0 <2.0)
- rumamel.yaml(>=0.17.32 <0.18.0)

## Usage

check the [notebook](notebooks/intro.ipynb) that contains everything about how to use **DataProfiler** module in profiling datasets, and how to use **QTest** module to create quality check tests.

check the [notebook](notebooks/quality_pipeline.ipynb) that contains everything about how to use **QPipeline** 

## Contributing

Pull requests are welcome. For major changes, please open an issue first
to discuss what you would like to change.

Please make sure to update tests as appropriate.

## Licence
[MIT](LICENSE)

## New in v0.2.3

- Create Quality Pipeline(v0.2.2).
- enhance documentation.
- add utility method in DataProfiler to .dprofiler structure tree.
