odd-great-expectations


Nameodd-great-expectations JSON
Version 0.1.13 PyPI version JSON
download
home_page
SummaryOpenDataDiscovery Action for Great Expectations
upload_time2023-07-03 06:20:09
maintainer
docs_urlNone
authorPavel Makarichev
requires_python>=3.9,<4.0
licenseApache-2.0
keywords open data discovery great expectations metadata data discovery data observability
VCS
bugtrack_url
requirements No requirements were recorded.
Travis-CI No Travis.
coveralls test coverage No coveralls.
            ## 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>
      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_PLATFORM` 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": "",
    "name": "odd-great-expectations",
    "maintainer": "",
    "docs_url": null,
    "requires_python": ">=3.9,<4.0",
    "maintainer_email": "",
    "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/a6/92/983577689e01558bcbcbb39197f37f37265a0a69205c537401d12898128f/odd_great_expectations-0.1.13.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      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_PLATFORM` 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.1.13",
    "project_urls": null,
    "split_keywords": [
        "open data discovery",
        "great expectations",
        "metadata",
        "data discovery",
        "data observability"
    ],
    "urls": [
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "aa5e76b7427b87a68a5a761f2dfb21a4fa5de6f69ef84e720eeddc51bcba0a54",
                "md5": "c0f59c1858ed27115250140cbebf69d1",
                "sha256": "5908c338717c888f31bd13b1a8447221811c9836cfa343838f01293d0ff4713e"
            },
            "downloads": -1,
            "filename": "odd_great_expectations-0.1.13-py3-none-any.whl",
            "has_sig": false,
            "md5_digest": "c0f59c1858ed27115250140cbebf69d1",
            "packagetype": "bdist_wheel",
            "python_version": "py3",
            "requires_python": ">=3.9,<4.0",
            "size": 11392,
            "upload_time": "2023-07-03T06:20:08",
            "upload_time_iso_8601": "2023-07-03T06:20:08.146023Z",
            "url": "https://files.pythonhosted.org/packages/aa/5e/76b7427b87a68a5a761f2dfb21a4fa5de6f69ef84e720eeddc51bcba0a54/odd_great_expectations-0.1.13-py3-none-any.whl",
            "yanked": false,
            "yanked_reason": null
        },
        {
            "comment_text": "",
            "digests": {
                "blake2b_256": "a692983577689e01558bcbcbb39197f37f37265a0a69205c537401d12898128f",
                "md5": "3fa32990e53f59668a0ae55ad759618a",
                "sha256": "1e21712ea79521747a79dd688def882161adaa68a9968b183ccad86d0f8f7feb"
            },
            "downloads": -1,
            "filename": "odd_great_expectations-0.1.13.tar.gz",
            "has_sig": false,
            "md5_digest": "3fa32990e53f59668a0ae55ad759618a",
            "packagetype": "sdist",
            "python_version": "source",
            "requires_python": ">=3.9,<4.0",
            "size": 9615,
            "upload_time": "2023-07-03T06:20:09",
            "upload_time_iso_8601": "2023-07-03T06:20:09.454616Z",
            "url": "https://files.pythonhosted.org/packages/a6/92/983577689e01558bcbcbb39197f37f37265a0a69205c537401d12898128f/odd_great_expectations-0.1.13.tar.gz",
            "yanked": false,
            "yanked_reason": null
        }
    ],
    "upload_time": "2023-07-03 06:20:09",
    "github": false,
    "gitlab": false,
    "bitbucket": false,
    "codeberg": false,
    "lcname": "odd-great-expectations"
}
        
Elapsed time: 0.08440s