Skip to content

PrefectHQ/prefect-great-expectations

Repository files navigation

prefect-great-expectations

PyPI

Welcome!

Prefect integration for interacting with Great Expectations.

Great Expectations is a Python library for data quality. It provides a framework to validate your state of data.

Getting Started

Python setup

Requires an installation of Python 3.7+.

We recommend using a Python virtual environment manager such as pipenv, conda, or virtualenv.

These tasks are designed to work with Prefect 2. For more information about how to use Prefect, please refer to the Prefect documentation.

Installation

Install prefect-great-expectations with pip:

pip install prefect-great-expectations

Write and run a flow

from prefect import flow
from prefect_great_expectations import run_checkpoint_validation

@flow
def example_flow():
   run_checkpoint_validation(checkpoint_name="my_checkpoint")

example_flow()

Tutorial

For a larger example, check out the tutorial.

Resources

If you encounter any bugs while using prefect-great-expectations, feel free to open an issue in the prefect-great-expectations repository.

If you have any questions or issues while using prefect-great-expectations, you can find help in either the Prefect Discourse forum or the Prefect Slack community.

Feel free to ⭐️ or watch prefect-great-expectations for updates too!

Development

If you'd like to install a version of prefect-great-expectations for development, clone the repository and perform an editable install with pip:

git clone https://github.com/PrefectHQ/prefect-great-expectations.git

cd prefect-great-expectations/

pip install -e ".[dev]"

# Install linting pre-commit hooks
pre-commit install