分布式调度框架。
You can not select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
 
 
 
 
 
 
Jiajie Zhong aa117136cf
[deploy] Make python api release to ASF dist independent (#8472)
3 years ago
..
docs [cherry-pick][python] Pick laster code from dev branch (#8474) 3 years ago
src/pydolphinscheduler [cherry-pick][python] Pick laster code from dev branch (#8474) 3 years ago
tests [cherry-pick][python] Pick laster code from dev branch (#8474) 3 years ago
.coveragerc [cherry-pick][python] Make dolphinscheduler python API works to 2.0.2 (#7608) 3 years ago
.flake8 [cherry-pick][python] Pick laster code from dev branch (#8474) 3 years ago
.isort.cfg [cherry-pick][python] Make dolphinscheduler python API works to 2.0.2 (#7608) 3 years ago
DEVELOP.md [cherry-pick][python] Pick laster code from dev branch (#8474) 3 years ago
README.md [cherry-pick][python] Pick laster code from dev branch (#8474) 3 years ago
RELEASE.md [cherry-pick][python] Pick laster code from dev branch (#8474) 3 years ago
pytest.ini [cherry-pick][python] Make dolphinscheduler python API works to 2.0.2 (#7608) 3 years ago
setup.cfg [cherry-pick][python] Make dolphinscheduler python API works to 2.0.2 (#7608) 3 years ago
setup.py [deploy] Make python api release to ASF dist independent (#8472) 3 years ago

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
$ pip install apache-dolphinscheduler

# Check installation, it is success if you see version output, here we use 0.1.0 as example
$ python -c "import pydolphinscheduler; print(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 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 document