commit | 05f87a99b1e007733ee83cf71d8768e404cfee9e | [log] [tgz] |
---|---|---|
author | Jay Chung <zhongjiajie955@gmail.com> | Wed Nov 09 17:46:25 2022 +0800 |
committer | GitHub <noreply@github.com> | Wed Nov 09 17:46:25 2022 +0800 |
tree | 488c4499f3096334c1359467bf16c6c71899e485 | |
parent | 6cd9784534eb3c78dbbf0daf53bf457a597fe3be [diff] |
[chore] Migrate code from main repo apache/dolphinscheduler (#1) Currently, our Python API code is a module in apache/dolphinscheduler codebase, each time users change Python API code, they need to run all requests CI check for dolphinscheduler and Python API, But if the user does only change Python code, it could be merged if Python API CI pass and do not dependent on others CI. Besides, we release Python API as the same version of dolphinscheduler. It is easy for user to match Python API version. But when Python API does not change any code, but dolphinscheduler release a bugfix version, Python API has to release the new version to match dolphinscheduler. This happened when we released Python API 2.0.6 and 2.0.7. 2.0.6 and 2.0.7 is bugfix version, and Python API does not change any code, so the PyPI package is the same. Separate Python API also makes our code more sense, we will have more distinguished code in dolphinscheduler and Python API new repository. Have separate issue tracker and changelog for information to users. see more detail in mail thread: https://lists.apache.org/thread/4z7l5l54c4d81smjlk1n8nq380p9f0oo
PyDolphinScheduler is python API for Apache DolphinScheduler, which allow you definition your workflow by python code, aka workflow-as-codes.
# 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
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-sdk-python/main/src/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 istenant_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.
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
If you are interested in how to release PyDolphinScheduler, you could go and see at release
For more detail information, please go to see PyDolphinScheduler latest(unreleased) document