6f5ea6e411
* Remove add leading `$` from command
* Add copy button from code block
* Using `python -m pip` to install package avoid error
(cherry picked from commit
|
||
---|---|---|
.. | ||
docs | ||
src/pydolphinscheduler | ||
tests | ||
.coveragerc | ||
.flake8 | ||
.isort.cfg | ||
.pre-commit-config.yaml | ||
DEVELOP.md | ||
LICENSE | ||
NOTICE | ||
pytest.ini | ||
README.md | ||
RELEASE.md | ||
setup.cfg | ||
setup.py | ||
tox.ini | ||
UPDATING.md |
pydolphinscheduler
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
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 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.
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 document