github
/
DolphinScheduler
mirror of https://gitee.com/dolphinscheduler/DolphinScheduler.git
1
0
Fork 0
Code Issues Releases Wiki Activity
分布式调度框架。
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.
7307 Commits
30 Branches
59 Tags
297 MiB
 
 
 
 
 
 
Tree: b953cdc559
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from 'b953cdc559'
${ noResults }
DolphinScheduler/dolphinscheduler-python/pydolphinscheduler
chenrj 9652964c94
[python] Add resource plugin for python, dataX, CustomDataX and Sql (#12135) 		2 years ago
..
docs [python] Add new resource plugin: gitlab, OSS and S3 (#12025) 2 years ago
examples/yaml_define [improve] Remove the spark version of spark task (#11860) 2 years ago
src/pydolphinscheduler [python] Add resource plugin for python, dataX, CustomDataX and Sql (#12135) 2 years ago
tests [python] Add resource plugin for python, dataX, CustomDataX and Sql (#12135) 2 years ago
.coveragerc [python] Add tox for out of box test (#8837) 3 years ago
.flake8 [Feature-8591][Python] Add pre-commit to run basic test before commit (#8843) 3 years ago
.isort.cfg [ci][python] Add isort to sort out import (#6871) 3 years ago
DEVELOP.md [Doc][Style] Fix doc format once for all (#12006) 2 years ago
LICENSE [python] Add LICENSE and NOTICE to python dist package (#8768) 3 years ago
NOTICE [python] Add LICENSE and NOTICE to python dist package (#8768) 3 years ago
README.md [Doc][Style] Fix doc format once for all (#12006) 2 years ago
RELEASE.md [Doc][Style] Fix doc format once for all (#12006) 2 years ago
UPDATING.md [improve] Remove the spark version of spark task (#11860) 2 years ago
pytest.ini [python] Fix change exists pd attribute user error (#9140) 3 years ago
setup.cfg Add Python API implementation of workflows-as-code (#6269) 3 years ago
setup.py [python] Add new resource plugin: gitlab, OSS and S3 (#12025) 2 years ago
tox.ini [python] Add support interpreter version 310 and 311-dev (#11170) 2 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
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