Apache DolphinScheduler SDK-Python 开源项目安装与使用指南

Apache DolphinScheduler SDK-Python 开源项目安装与使用指南

dolphinscheduler-sdk-pythonApache DolphinScheduler Python API, aka PyDolphinscheduler.项目地址:https://gitcode.com/gh_mirrors/do/dolphinscheduler-sdk-python

目录结构及介绍

Apache DolphinScheduler SDK-Python 是一个用于 Apache DolphinScheduler 的 Python API 库，允许开发者通过 Python 代码来定义工作流（workflow-as-code）。其主要目录结构如下：

• src: 包含了库的主要源码。
  • pydolphinscheduler: 主要模块，提供了与 Apache DolphinScheduler 交互的接口。
    • examples: 示例代码，展示如何使用 PyDolphinscheduler 定义和管理工作流。

目录详细说明:

src

这是 SDK 的核心代码存放地，包含了所有实现 PyDolphinscheduler 功能的代码。

examples

该目录下包含了一些示例脚本，用来演示如何使用 PyDolphinscheduler 来创建、管理和执行工作流任务。

启动文件介绍

由于 Apache DolphinScheduler SDK-Python 是一个 SDK 而非独立应用，因此没有特定的“启动”文件。然而，在使用这个 SDK 前，需要先确保 Apache DolphinScheduler 服务端已经正确运行。以下是一种典型的启动 DolphinScheduler 的方式：

在 Docker 环境中，可以通过以下命令运行 Apache DolphinScheduler 的服务器：

DOLPHINSCHEDULER_VERSION=3.1.1
docker run --name dolphinscheduler-standalone-server \
           -p 12345:12345 \
           -p 25333:25333 \
           -e API_PYTHON_GATEWAY_ENABLED="true" \
           -d apache/dolphinscheduler-standalone-server:"$[DOLPHINSCHEDULER_VERSION]"

此命令将启动一个 DolphinScheduler 的服务器实例，映射了必要的端口以供外部访问，并启用了 Python Gateway API。

当容器成功启动后，可访问其 web UI 地址: http://localhost:12345/dolphinscheduler，进行进一步的操作或监控。

配置文件介绍

对于 SDK 自身而言，通常不需要额外的配置文件；它依赖于已部署的 Apache DolphinScheduler 实例的设置和环境变量。但为了能够正常与 DolphinScheduler 实例通信，你可能需要在你的 Python 项目中设置一些与连接和认证相关的参数。

例如，当你在 Python 脚本中使用 PyDolphinscheduler 连接到一个远程的 DolphinScheduler 实例时，你需要确保下面的信息已经被正确地设置：

• API_URL: 指向 DolphinScheduler REST API 的 URL。
• USER_NAME 和 PASSWORD: 访问 DolphinScheduler 所需的用户名和密码。

这些设置通常不存储在单一的配置文件中，而是作为环境变量或者在你调用 PyDolphinscheduler 方法的时候被指定。具体的方法可以根据 SDK 的文档和最新的版本来进行操作。然而，具体到版本的细节，请参考 SDK 发布时提供的文档，以获得最新的指引和最佳实践。

总之，虽然 Apache DolphinScheduler SDK-Python 不自带复杂的配置文件系统，但是良好的集成意味着你需要了解并妥善处理与目标 DolphinScheduler 实例的连接信息。此外，安全和私密数据如用户名和密码应该遵循安全性最佳实践来处理，避免硬编码和泄露风险。如果你希望在多处重用这些连接信息，可以考虑写入环境变量、秘密管理系统或创建适当的安全环境以适应团队的需求。

dolphinscheduler-sdk-pythonApache DolphinScheduler Python API, aka PyDolphinscheduler.项目地址:https://gitcode.com/gh_mirrors/do/dolphinscheduler-sdk-python