# prefect-great-expectations
<p align="center">
<a href="https://pypi.python.org/pypi/prefect-great-expectations/" alt="PyPI version">
<img alt="PyPI" src="https://img.shields.io/pypi/v/prefect-great-expectations?color=0052FF&labelColor=090422"></a>
<a href="https://github.com/PrefectHQ/prefect-great-expectations/" alt="Stars">
<img src="https://img.shields.io/github/stars/PrefectHQ/prefect-great-expectations?color=0052FF&labelColor=090422" /></a>
<a href="https://pepy.tech/badge/prefect-great-expectations/" alt="Downloads">
<img src="https://img.shields.io/pypi/dm/prefect-great-expectations?color=0052FF&labelColor=090422" /></a>
<a href="https://github.com/PrefectHQ/prefect-great-expectations/pulse" alt="Activity">
<img src="https://img.shields.io/github/commit-activity/m/PrefectHQ/prefect-great-expectations?color=0052FF&labelColor=090422" /></a>
<br>
<a href="https://prefect-great-expectations-community.slack.com" alt="Slack">
<img src="https://img.shields.io/badge/slack-join_community-red.svg?color=0052FF&labelColor=090422&logo=slack" /></a>
<a href="https://discourse.prefect-great-expectations.io/" alt="Discourse">
<img src="https://img.shields.io/badge/discourse-browse_forum-red.svg?color=0052FF&labelColor=090422&logo=discourse" /></a>
</p>
## 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
```
Raw data
{
"_id": null,
"home_page": "https://github.com/PrefectHQ/prefect-great-expectations",
"name": "prefect-great-expectations",
"maintainer": "",
"docs_url": null,
"requires_python": ">=3.7",
"maintainer_email": "",
"keywords": "prefect",
"author": "Prefect Technologies, Inc.",
"author_email": "help@prefect.io",
"download_url": "https://files.pythonhosted.org/packages/cd/67/7f7792a69ccb19fc176338d402f18845a5ca19585c74e5eaa6f63d13397b/prefect-great-expectations-0.2.1.tar.gz",
"platform": null,
"description": "# prefect-great-expectations\n\n<p align=\"center\">\n <a href=\"https://pypi.python.org/pypi/prefect-great-expectations/\" alt=\"PyPI version\">\n <img alt=\"PyPI\" src=\"https://img.shields.io/pypi/v/prefect-great-expectations?color=0052FF&labelColor=090422\"></a>\n <a href=\"https://github.com/PrefectHQ/prefect-great-expectations/\" alt=\"Stars\">\n <img src=\"https://img.shields.io/github/stars/PrefectHQ/prefect-great-expectations?color=0052FF&labelColor=090422\" /></a>\n <a href=\"https://pepy.tech/badge/prefect-great-expectations/\" alt=\"Downloads\">\n <img src=\"https://img.shields.io/pypi/dm/prefect-great-expectations?color=0052FF&labelColor=090422\" /></a>\n <a href=\"https://github.com/PrefectHQ/prefect-great-expectations/pulse\" alt=\"Activity\">\n <img src=\"https://img.shields.io/github/commit-activity/m/PrefectHQ/prefect-great-expectations?color=0052FF&labelColor=090422\" /></a>\n <br>\n <a href=\"https://prefect-great-expectations-community.slack.com\" alt=\"Slack\">\n <img src=\"https://img.shields.io/badge/slack-join_community-red.svg?color=0052FF&labelColor=090422&logo=slack\" /></a>\n <a href=\"https://discourse.prefect-great-expectations.io/\" alt=\"Discourse\">\n <img src=\"https://img.shields.io/badge/discourse-browse_forum-red.svg?color=0052FF&labelColor=090422&logo=discourse\" /></a>\n</p>\n\n## Welcome!\n\nPrefect integration for interacting with Great Expectations.\n\n[Great Expectations](https://greatexpectations.io/gx-oss) is a Python library for data quality. It provides a framework to validate your state of data.\n\n## Getting Started\n\n### Python setup\n\nRequires an installation of Python 3.7+.\n\nWe recommend using a Python virtual environment manager such as pipenv, conda, or virtualenv.\n\nThese 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/).\n\n### Installation\n\nInstall `prefect-great-expectations` with `pip`:\n\n```bash\npip install prefect-great-expectations\n```\n\n### Write and run a flow\n\n```python\nfrom prefect import flow\nfrom prefect_great_expectations import run_checkpoint_validation\n\n@flow\ndef example_flow():\n run_checkpoint_validation(checkpoint_name=\"my_checkpoint\")\n\nexample_flow()\n```\n\n## Tutorial\n\nFor a larger example, check out the [tutorial](tutorial.md).\n\n## Resources\n\nIf 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.\n\nIf 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).\n\nFeel free to \u2b50\ufe0f or watch [`prefect-great-expectations`](https://github.com/PrefectHQ/prefect-great-expectations) for updates too!\n\n## Development\n\nIf you'd like to install a version of `prefect-great-expectations` for development, clone the repository and perform an editable install with `pip`:\n\n```bash\ngit clone https://github.com/PrefectHQ/prefect-great-expectations.git\n\ncd prefect-great-expectations/\n\npip install -e \".[dev]\"\n\n# Install linting pre-commit hooks\npre-commit install\n```\n",
"bugtrack_url": null,
"license": "Apache License 2.0",
"summary": "Prefect Collection containing integrations for interacting with Great Expectations",
"version": "0.2.1",
"project_urls": {
"Homepage": "https://github.com/PrefectHQ/prefect-great-expectations"
},
"split_keywords": [
"prefect"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "bfe90481cb4c0b2c7a12aa396478491b37fd267995b340679767b49b4226e9fa",
"md5": "9a4d18a918d337381106be378d92fa95",
"sha256": "679d9408844622fee389f320954ef41467938b889ab5d9b0b38448fc90fec1a4"
},
"downloads": -1,
"filename": "prefect_great_expectations-0.2.1-py3-none-any.whl",
"has_sig": false,
"md5_digest": "9a4d18a918d337381106be378d92fa95",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.7",
"size": 9236,
"upload_time": "2023-11-13T22:52:42",
"upload_time_iso_8601": "2023-11-13T22:52:42.871345Z",
"url": "https://files.pythonhosted.org/packages/bf/e9/0481cb4c0b2c7a12aa396478491b37fd267995b340679767b49b4226e9fa/prefect_great_expectations-0.2.1-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "cd677f7792a69ccb19fc176338d402f18845a5ca19585c74e5eaa6f63d13397b",
"md5": "fdd4e4c8bd3c365e28b2ac3d9c18572e",
"sha256": "a91f13db001808f6d978901c252aba985160e382aef05c89b0db97ef05385e37"
},
"downloads": -1,
"filename": "prefect-great-expectations-0.2.1.tar.gz",
"has_sig": false,
"md5_digest": "fdd4e4c8bd3c365e28b2ac3d9c18572e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.7",
"size": 27395,
"upload_time": "2023-11-13T22:52:44",
"upload_time_iso_8601": "2023-11-13T22:52:44.012566Z",
"url": "https://files.pythonhosted.org/packages/cd/67/7f7792a69ccb19fc176338d402f18845a5ca19585c74e5eaa6f63d13397b/prefect-great-expectations-0.2.1.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-13 22:52:44",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "PrefectHQ",
"github_project": "prefect-great-expectations",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "prefect-great-expectations"
}
JSON
