sodadata/soda-scan-launcher

soda-scan-launcher

镜像概述和主要用途

soda-scan-launcher是一个简单的Python CLI工具，用于启动Soda Cloud中配置的soda core扫描任务。该启动器旨在由Soda Agent的编排器通过Docker镜像使用。

核心功能和特性

• 提供start命令，用于启动soda core扫描任务
• 运行前需设置特定环境变量，未设置则以退出代码1终止运行
• 支持以SA_为前缀的环境变量传递给soda core扫描命令（例如SA_POSTGRES_USERNAME将作为POSTGRES_USERNAME传递）

使用场景和适用范围

主要适用于Soda Agent的编排器通过Docker镜像启动soda core扫描任务的场景。

使用方法和配置说明

环境变量要求

运行start命令前，必须设置以下环境变量：

• SODA_API_KEY_ID
• SODA_API_KEY_SECRET
• SODA_CLOUD_ENDPOINT
• SODA_SCAN_DEFINITION
• SODA_SCAN_DATA_TIMESTAMP

若上述任一环境变量未设置，启动器将以退出代码1终止运行。

传递额外环境变量

如需向soda core扫描命令传递额外环境变量，需使用SA_作为前缀。例如，要传递POSTGRES_USERNAME环境变量，需设置SA_POSTGRES_USERNAME。

开发设置

这是一个典型的Python模块，所有源代码位于src目录，setup.py包含所需依赖。安装开发工具需执行以下命令安装开发依赖：

bash
pip install -r dev-requirements.txt

若修改dev-requirements.in，可使用以下命令生成更新版本：

bash
pip-compile dev-requirements.in

确保将修改后的dev-requirements.in和生成的文件一起提交。

版本控制与发布

该包的版本应与soda-core模块保持一致，确保版本同步。请勿手动修改版本，需使用tbump工具，该工具将更新版本、为代码打标签并推送到GitHub。