Google Git
Sign in
apache / dolphinscheduler-sdk-python / refs/tags/3.1.0
tagda9d538d0132ec4e114c0e22f9a629249c8a6917
taggerJiajie Zhong <zhongjiajie955@gmail.com>Wed Nov 09 14:44:18 2022 +0800
object6cd9784534eb3c78dbbf0daf53bf457a597fe3be 
Version 3.1.0
commit6cd9784534eb3c78dbbf0daf53bf457a597fe3be[log] [tgz]
authorJay Chung <zhongjiajie955@gmail.com>Wed Nov 09 11:51:52 2022 +0800
committerGitHub <noreply@github.com>Wed Nov 09 11:51:52 2022 +0800
tree04e47371e76f5dd3e4e2d3ca7579dd3346769d3b
parentc55c0f7c6fab26fa4df58f2b6c5237bb0c1db621 [diff]
[migrate] Add tag 3.1.0 source code (#6)

Add version 3.1.0 code from https://github.com/apache/dolphinscheduler/tree/3.1.0/dolphinscheduler-python/pydolphinscheduler
103 files changed
tree: 04e47371e76f5dd3e4e2d3ca7579dd3346769d3b
  1. .github/
  2. docs/
  3. examples/
  4. src/
  5. tests/
  6. .asf.yaml
  7. .coveragerc
  8. .flake8
  9. .isort.cfg
  10. .pre-commit-config.yaml
  11. DEVELOP.md
  12. LICENSE
  13. NOTICE
  14. pytest.ini
  15. README.md
  16. RELEASE.md
  17. setup.cfg
  18. setup.py
  19. tox.ini
  20. UPDATING.md
README.md

pydolphinscheduler

PyPi Version PyPi Python Versions PyPi License PyPi Status PyPi Downloads

Code style: black Imports: isort GitHub Build

PyDolphinScheduler is python API for Apache DolphinScheduler, which allow you definition your workflow by python code, aka workflow-as-codes.

Quick Start

Installation

# Install
python -m pip install apache-dolphinscheduler

# Verify installation is successful, it will show the version of apache-dolphinscheduler, here we use 0.1.0 as example
pydolphinscheduler version
# 0.1.0

NOTE: package apache-dolphinscheduler not work on above Python version 3.10(including itself) in Window operating system due to dependence py4j not work on those environments.

Here we show you how to install and run a simple example of pydolphinscheduler

Start Server And Run Example

Before you run an example, you have to start backend server. You could follow development setup section “DolphinScheduler Standalone Quick Start” to set up developer environment. You have to start backend and frontend server in this step, which mean that you could view DolphinScheduler UI in your browser with URL http://localhost:12345/dolphinscheduler

After backend server is being start, all requests from pydolphinscheduler would be sent to backend server. And for now we could run a simple example by:

# Please make sure your terminal could 
curl https://raw.githubusercontent.com/apache/dolphinscheduler/dev/dolphinscheduler-python/pydolphinscheduler/examples/tutorial.py -o ./tutorial.py
python ./tutorial.py

NOTICE: Since Apache DolphinScheduler's tenant is requests while running command, you might need to change tenant value in example/tutorial.py. For now the value is tenant_exists, please change it to username exists in you environment.

After command execute, you could see a new project with single process definition named tutorial in the UI-project list.

Develop

Until now, we finish quick start by an example of pydolphinscheduler and run it. If you want to inspect or join pydolphinscheduler develop, you could take a look at develop

Release

If you are interested in how to release PyDolphinScheduler, you could go and see at release

What's more

For more detail information, please go to see PyDolphinScheduler latest(unreleased) document