JieguangZhou c41fa5a8b1 fix pydolphin yaml doc link (#11817)		преди 2 години
..
docs	c41fa5a8b1 fix pydolphin yaml doc link (#11817)	преди 2 години
examples	38ee91fb1e [DSIP-11][python] create workflows from YAML configuration (#11611)	преди 2 години
src	6d460a3ca2 [DSIP-13][python] New mechanism file plugins to Python API (#11360)	преди 2 години
tests	6d460a3ca2 [DSIP-13][python] New mechanism file plugins to Python API (#11360)	преди 2 години
.coveragerc	90f9aed11d [python] Add tox for out of box test (#8837)	преди 3 години
.flake8	a308fa3bef [Feature-8591][Python] Add pre-commit to run basic test before commit (#8843)	преди 3 години
.isort.cfg	7c5c7ec907 [ci][python] Add isort to sort out import (#6871)	преди 3 години
.pre-commit-config.yaml	e53ac4e304 [python] Add autoflake to auto rm unused import (#8897)	преди 3 години
DEVELOP.md	26afd655cb [python] Add multiple version of document (#11391)	преди 2 години
LICENSE	62e12c73dc [python] Add LICENSE and NOTICE to python dist package (#8768)	преди 3 години
NOTICE	62e12c73dc [python] Add LICENSE and NOTICE to python dist package (#8768)	преди 3 години
README.md	4d427ee215 [python] Add support interpreter version 310 and 311-dev (#11170)	преди 2 години
RELEASE.md	983f9b41bf [Doc] Add tools/libs to the init database steps (#11345)	преди 2 години
UPDATING.md	4dca488cd5 [python] Auto location when create process definition (#11681)	преди 2 години
pytest.ini	5289b09817 [python] Fix change exists pd attribute user error (#9140)	преди 3 години
setup.cfg	dd6ed36f65 Add Python API implementation of workflows-as-code (#6269)	преди 3 години
setup.py	c59a8503f4 update PyDolphinScheduler documentation link. (#11474)	преди 2 години
tox.ini	4d427ee215 [python] Add support interpreter version 310 and 311-dev (#11170)	преди 2 години

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

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

README.md