History

Eric Gao d46e4659d9 [Improvement][Style] Fix remaining style errors and wildcard imports (#12412 ) * Fix remaining style errors and wildcard imports * Upgrade spotless to the latest stable version, exclude .github folder from spotless check and fix dead link * Fix spotless matching scope of markdown files		2022-10-19 11:08:04 +08:00
..
docs	[python] Add new resource plugin: gitlab, OSS and S3 (#12025 )	2022-10-10 18:07:57 +08:00
examples/yaml_define	[improve] Remove the spark version of spark task (#11860 )	2022-09-21 20:27:28 +08:00
src/pydolphinscheduler	[Bug][Python] Python class description error (#12360 )	2022-10-15 07:43:17 +08:00
tests	[python] Add resource plugin for python, dataX, CustomDataX and Sql (#12135 )	2022-10-13 19:14:54 +08:00
.coveragerc	[python] Add tox for out of box test (#8837 )	2022-03-12 21:27:36 +08:00
.flake8	[Feature-8591][Python] Add pre-commit to run basic test before commit (#8843 )	2022-03-14 20:51:55 +08:00
.isort.cfg	[ci][python] Add isort to sort out import (#6871 )	2021-11-17 11:48:52 +08:00
DEVELOP.md	[Improvement][Style] Fix remaining style errors and wildcard imports (#12412 )	2022-10-19 11:08:04 +08:00
LICENSE	[python] Add LICENSE and NOTICE to python dist package (#8768 )	2022-03-09 19:50:43 +08:00
NOTICE	[python] Add LICENSE and NOTICE to python dist package (#8768 )	2022-03-09 19:50:43 +08:00
README.md	[Doc][Style] Fix doc format once for all (#12006 )	2022-09-17 11:33:32 +08:00
RELEASE.md	[Doc][Style] Fix doc format once for all (#12006 )	2022-09-17 11:33:32 +08:00
UPDATING.md	[improve] Remove the spark version of spark task (#11860 )	2022-09-21 20:27:28 +08:00
pytest.ini	[python] Fix change exists pd attribute user error (#9140 )	2022-03-24 15:24:02 +08:00
setup.cfg	Add Python API implementation of workflows-as-code (#6269 )	2021-10-31 20:35:46 +08:00
setup.py	[python] Add new resource plugin: gitlab, OSS and S3 (#12025 )	2022-10-10 18:07:57 +08:00
tox.ini	[python] Add support interpreter version 310 and 311-dev (#11170 )	2022-08-11 23:39:44 +08:00

README.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

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