## OpenDataDiscovery Action for handling Great Expectations tests results.
[![PyPI version](https://badge.fury.io/py/odd-great-expectations.svg)](https://badge.fury.io/py/odd-great-expectations)
![image](assets/screenshot.png)
# What is it?
`odd_great_expectation.action.ODDAction`
Is a class derived from GX `ValidationAction` which will be run by GreatExpectations at runtime with `ValidationResult`s for checkpoint.
# How to use it?:
Install `odd-great-expectations` package
```bash
pip install odd-great-expectations
```
Add `ODDAction` action to some checkpoint's action list:
```yaml
name: <CHECKPOINT_NAME>
config_version: 1.0
...
action_list:
# other actions
- name: store_metadata_to_odd
action:
module_name: odd_great_expectations.action
class_name: ODDAction
platform_host: <PLATFORM_HOST>
platform_token: <PLATFORM_TOKEN> # collector token
data_source_name: <DATA_SOURCE_NAME>
```
Parameters:
`platform_host` - Location of OpenDataDiscovery platform, i.e. http://localhost:8080
`platform_token` - OpenDataDiscovery token, how to get it - https://docs.opendatadiscovery.org/configuration-and-deployment/trylocally#create-collector-entity
`data_source_name` - Unique name for data source, i.e. local_qa_test
Both `platform_host` and `platform_token` can be set using `ODD_PLATFORM_HOST` and `ODD_PLATFORM_TOKEN` env variables accordingly.
Run checkpoint
```bash
great_expectations checkpoint run <CHECKPOINT_NAME>
```
Check results on `PLATFORM_HOST` UI.
## Supporting features
| Feature | Supporting |
| --------------------------- | ---------- |
| V3 API + | + |
| SqlAlchemyEngine | + |
| PandasEngine | + |
| Great Expectations V2 API - | - |
| Cloud Solution | - |
Raw data
{
"_id": null,
"home_page": null,
"name": "odd-great-expectations",
"maintainer": null,
"docs_url": null,
"requires_python": "<4.0,>=3.9",
"maintainer_email": null,
"keywords": "Open Data Discovery, Great Expectations, Metadata, Data Discovery, Data Observability",
"author": "Pavel Makarichev",
"author_email": "vixtir90@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/57/ef/c8e923c0a5d31a5b26e0d8540022ec6a18d279fe802f20cc4d4ee6778324/odd_great_expectations-0.2.5.tar.gz",
"platform": null,
"description": "## OpenDataDiscovery Action for handling Great Expectations tests results.\n\n[![PyPI version](https://badge.fury.io/py/odd-great-expectations.svg)](https://badge.fury.io/py/odd-great-expectations)\n\n![image](assets/screenshot.png)\n\n# What is it?\n`odd_great_expectation.action.ODDAction`\nIs a class derived from GX `ValidationAction` which will be run by GreatExpectations at runtime with `ValidationResult`s for checkpoint.\n\n\n# How to use it?:\nInstall `odd-great-expectations` package\n```bash\npip install odd-great-expectations\n```\nAdd `ODDAction` action to some checkpoint's action list:\n```yaml\nname: <CHECKPOINT_NAME>\nconfig_version: 1.0\n...\naction_list:\n # other actions\n - name: store_metadata_to_odd\n action:\n module_name: odd_great_expectations.action\n class_name: ODDAction\n platform_host: <PLATFORM_HOST>\n platform_token: <PLATFORM_TOKEN> # collector token\n data_source_name: <DATA_SOURCE_NAME>\n```\n\nParameters:\n\n`platform_host` - Location of OpenDataDiscovery platform, i.e. http://localhost:8080\n\n`platform_token` - OpenDataDiscovery token, how to get it - https://docs.opendatadiscovery.org/configuration-and-deployment/trylocally#create-collector-entity\n\n`data_source_name` - Unique name for data source, i.e. local_qa_test\n\nBoth `platform_host` and `platform_token` can be set using `ODD_PLATFORM_HOST` and `ODD_PLATFORM_TOKEN` env variables accordingly.\n\nRun checkpoint\n```bash\ngreat_expectations checkpoint run <CHECKPOINT_NAME>\n```\nCheck results on `PLATFORM_HOST` UI.\n\n## Supporting features\n| Feature | Supporting |\n| --------------------------- | ---------- |\n| V3 API + | + |\n| SqlAlchemyEngine | + |\n| PandasEngine | + |\n| Great Expectations V2 API - | - |\n| Cloud Solution | - |\n",
"bugtrack_url": null,
"license": "Apache-2.0",
"summary": "OpenDataDiscovery Action for Great Expectations",
"version": "0.2.5",
"project_urls": null,
"split_keywords": [
"open data discovery",
" great expectations",
" metadata",
" data discovery",
" data observability"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "8d0f0fe7221092c0c86d6737000f03eff31b443d50757e368515a9961ce9c60b",
"md5": "aa50ef4ad26c3f197b96ed1866b818f6",
"sha256": "d6eff9aed62d2021b912809eca81ddabb928a6e18c05afb4f5ab13262c1362d8"
},
"downloads": -1,
"filename": "odd_great_expectations-0.2.5-py3-none-any.whl",
"has_sig": false,
"md5_digest": "aa50ef4ad26c3f197b96ed1866b818f6",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<4.0,>=3.9",
"size": 11708,
"upload_time": "2024-09-27T16:59:20",
"upload_time_iso_8601": "2024-09-27T16:59:20.227216Z",
"url": "https://files.pythonhosted.org/packages/8d/0f/0fe7221092c0c86d6737000f03eff31b443d50757e368515a9961ce9c60b/odd_great_expectations-0.2.5-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "57efc8e923c0a5d31a5b26e0d8540022ec6a18d279fe802f20cc4d4ee6778324",
"md5": "6562bb1d24d5b5dc2769dd32240cdaf4",
"sha256": "d4fe3a1759e073307d035c95df1a8c3d164abebe6e3e465ffadd001fdea905c7"
},
"downloads": -1,
"filename": "odd_great_expectations-0.2.5.tar.gz",
"has_sig": false,
"md5_digest": "6562bb1d24d5b5dc2769dd32240cdaf4",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<4.0,>=3.9",
"size": 10422,
"upload_time": "2024-09-27T16:59:21",
"upload_time_iso_8601": "2024-09-27T16:59:21.573646Z",
"url": "https://files.pythonhosted.org/packages/57/ef/c8e923c0a5d31a5b26e0d8540022ec6a18d279fe802f20cc4d4ee6778324/odd_great_expectations-0.2.5.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-09-27 16:59:21",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "odd-great-expectations"
}