天仇 a308fa3bef [Feature-8591][Python] Add pre-commit to run basic test before commit (#8843)		3 tahun lalu
..
docs	3025f67d37 [python] Add mechanism cli only with version as subcommand (#8516)	3 tahun lalu
src	fb772c328d [python] Change name to_string to __str__ and add __repr__ (#8830)	3 tahun lalu
tests	fb772c328d [python] Change name to_string to __str__ and add __repr__ (#8830)	3 tahun lalu
.coveragerc	90f9aed11d [python] Add tox for out of box test (#8837)	3 tahun lalu
.flake8	a308fa3bef [Feature-8591][Python] Add pre-commit to run basic test before commit (#8843)	3 tahun lalu
.isort.cfg	7c5c7ec907 [ci][python] Add isort to sort out import (#6871)	3 tahun lalu
.pre-commit-config.yaml	a308fa3bef [Feature-8591][Python] Add pre-commit to run basic test before commit (#8843)	3 tahun lalu
DEVELOP.md	a308fa3bef [Feature-8591][Python] Add pre-commit to run basic test before commit (#8843)	3 tahun lalu
LICENSE	62e12c73dc [python] Add LICENSE and NOTICE to python dist package (#8768)	3 tahun lalu
NOTICE	62e12c73dc [python] Add LICENSE and NOTICE to python dist package (#8768)	3 tahun lalu
README.md	3025f67d37 [python] Add mechanism cli only with version as subcommand (#8516)	3 tahun lalu
RELEASE.md	f3d663a7ea [python] Clean deps and prepare release (#8210)	3 tahun lalu
UPDATING.md	fb772c328d [python] Change name to_string to __str__ and add __repr__ (#8830)	3 tahun lalu
pytest.ini	2e7036529c Add CI test for python API (#6636)	3 tahun lalu
setup.cfg	dd6ed36f65 Add Python API implementation of workflows-as-code (#6269)	3 tahun lalu
setup.py	90f9aed11d [python] Add tox for out of box test (#8837)	3 tahun lalu
tox.ini	90f9aed11d [python] Add tox for out of box test (#8837)	3 tahun lalu

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
$ 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 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

README.md