https://github.com/prefecthq/prefect-great-expectations
Prefect integrations for interacting with Great Expectations
https://github.com/prefecthq/prefect-great-expectations
expectations great great-expectations prefect
Last synced: 3 months ago
JSON representation
Prefect integrations for interacting with Great Expectations
- Host: GitHub
- URL: https://github.com/prefecthq/prefect-great-expectations
- Owner: PrefectHQ
- License: apache-2.0
- Created: 2022-04-05T13:55:14.000Z (about 3 years ago)
- Default Branch: main
- Last Pushed: 2024-08-15T20:47:46.000Z (10 months ago)
- Last Synced: 2025-02-16T03:28:53.681Z (4 months ago)
- Topics: expectations, great, great-expectations, prefect
- Language: Python
- Homepage: https://prefecthq.github.io/prefect-great-expectations/
- Size: 2.18 MB
- Stars: 29
- Watchers: 14
- Forks: 3
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Codeowners: .github/CODEOWNERS
Awesome Lists containing this project
README
# prefect-great-expectations
## Welcome!
Prefect integration for interacting with Great Expectations.
[Great Expectations](https://greatexpectations.io/gx-oss) 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](https://docs.prefect.io/).
### Installation
Install `prefect-great-expectations` with `pip`:
```bash
pip install prefect-great-expectations
```
### Write and run a flow
```python
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](tutorial.md).
## Resources
If you encounter any bugs while using `prefect-great-expectations`, feel free to open an issue in the [prefect-great-expectations](https://github.com/PrefectHQ/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](https://discourse.prefect.io/) or the [Prefect Slack community](https://prefect.io/slack).
Feel free to ⭐️ or watch [`prefect-great-expectations`](https://github.com/PrefectHQ/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`:
```bash
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
```