sodadata/soda-scan-launcher repository overview

⁠soda-scan-launcher

Scan Launcher is a simple python CLI tool to start the soda core scan jobs configured in Soda Cloud.

The launcher is intended to be used by Soda Agent's orchestrator via Docker image. The CLI tool provides one command start. Before the command is started, make sure that following environment variables are set:

• SODA_API_KEY_ID
• SODA_API_KEY_SECRET
• SODA_CLOUD_ENDPOINT
• SODA_SCAN_DEFINITION
• SODA_SCAN_DATA_TIMESTAMP

If any one of the above is not set, the launcher will exit with code 1. Also, if you set any env variables with a prefix SA_ they will be passed to the soda core scan command. So if you want to pass POSTGRES_USERNAME make sure you set SA_POSTGRES_USERNAME.

⁠Development setup

This is a typical python module, with all the sources in src and the setup.py contains the dependencies needed. To install the development tools, install dev-requirements using pip install -r dev-requirements.txt. If you modify the dev-requirements.in, you can generate an updated version using pip-compile dev-requirements.in. Make sure that you stage/commit both files.

⁠Versioning and Release

The version of the package is meant to be same as the soda-core modules, so please make sure that they are in sync. And do not modify the versions manually use the tbump tool, that will make the necessary changes to the versions, tags the code and pushes to github.