Great Expectations Cloud
Project description
cloud
Quick Start
Python
Install
pip install great_expectations_cloud
Optional Dependencies
pip install 'great_expectations_cloud[sql]'
$ gx-agent --help
usage: gx-agent [-h] [--log-level LOG_LEVEL] [--skip-log-file SKIP_LOG_FILE] [--log-cfg-file LOG_CFG_FILE] [--version]
optional arguments:
-h, --help show this help message and exit
--log-level LOG_LEVEL
Level of logging to use. Defaults to WARNING.
--skip-log-file SKIP_LOG_FILE
Skip writing debug logs to a file. Defaults to False. Does not affect logging to stdout/stderr.
--log-cfg-file LOG_CFG_FILE
Path to a logging configuration json file. Supersedes --log-level and --skip-log-file.
--version Show the gx agent version.
Set env variables
GX_CLOUD_ACCESS_TOKEN
GX_CLOUD_ORGANIZATION_ID
Start the Agent
If you intend to run the agent against local services (Cloud backend or datasources) run the agent outside of the container.
gx-agent
Docker
Building and running the Agent with Docker
Dev Setup
See also CONTRIBUTING.md
- Install
poetry - Set up virtual environment and install dependencies.
poetry install --sync
- Activate your virtual environment.
poetry shell
- Set up precommit hooks
pre-commit install
Developer Tasks
Common developer tasks are available via invoke (defined in tasks.py)
invoke --list to see available tasks.
Synchronize Dependencies
To ensure you are using the latest version of the core and development dependencies run poetry install --sync.
Also available as an invoke task.
invoke deps
Updating poetry.lock dependencies
The dependencies installed in our CI and the docker build step are determined by the poetry.lock file.
To update only a specific dependency (such as great_expectations) ...
poetry update great_expectations
To resolve and update all dependencies ...
poetry lock
In either case, the updated poetry.lock file must be committed and merged to main.
Release to PyPI and Docker
To release a new version to PyPI the version must be incremented.
New versions are automatically published to PyPI when merging to main.
invoke version-bump
A new docker tag will also be generated and pushed to Docker Hub.
Building and Running the GX Agent Image
To build the GX Agent Docker image, run the following in the root dir:
invoke docker
Running the GX Agent:
invoke docker --run
or
docker run --env GX_CLOUD_ACCESS_TOKEN="<GX_TOKEN>" --env GX_CLOUD_ORGANIZATION_ID="<GX_ORG_ID>" gx/agent
Now go into GX Cloud and issue commands for the GX Agent to run, such as generating an Expectation Suite for a Data Source.
Note if you are pushing out a new image update the image tag version in
containerize-agent.yaml. The image will be built and pushed out via GitHub Actions.
Example Data
The contents from /examples/agent/data will be copied to /data for the docker container.
Adding an action to the agent
- Make a new action in
great_expectations_cloud/agent/actions/in a separate file. - Register your action in the file it was created in using
great_expectations_cloud.agent.event_handler.register_event_action(). Register for the major version of GX Core that the action applies to, e.g.register_event_action("1", RunCheckpointEvent, RunCheckpointAction)registers the action for major version 1 of GX Core (e.g. 1.0.0). - Import your action in
great_expectations_cloud/agent/actions/__init__.py
Note: The agent is core-version specific but this registration mechanism allows us to preemptively work on actions for future versions of GX Core while still supporting the existing latest major version.
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
File details
Details for the file great_expectations_cloud-0.0.47.dev0.tar.gz.
File metadata
- Download URL: great_expectations_cloud-0.0.47.dev0.tar.gz
- Upload date:
- Size: 27.4 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 5bd213ff7c465bacb2c01ebaa9b51ac8610b8c35d7b639971a2792b2511b2ce7 |
|
| MD5 | 01dd0a17af57ce84e2a353b7362e907a |
|
| BLAKE2b-256 | 6994c07394a80ebf6b1b2b38f54b81f8e50704564074213cd06ed3d72b571370 |
File details
Details for the file great_expectations_cloud-0.0.47.dev0-py3-none-any.whl.
File metadata
- Download URL: great_expectations_cloud-0.0.47.dev0-py3-none-any.whl
- Upload date:
- Size: 36.0 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via: twine/5.0.0 CPython/3.12.2
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 9902989571df3fafff5e7527d8953e9f4adebcd89dcf1abcdf7db8786f1c7758 |
|
| MD5 | 1983be1c789ee7f725a43619cdc200fc |
|
| BLAKE2b-256 | 9a9ca4bc505b8d9ec7bf6e0bc886acf767aa65a24d42d626e5bc5473e1c4c35f |
