分布式调度框架。

History

Jiajie Zhong 7a766cbcf2 [python] Refactor structure to avoid cycle import (#11167 ) Currently, our core and side module dependent on each others. and will cause cycle import in our codebase, especially in issue #10905, we try to refactor to solve this problem. This patch do the following change: * Rename module `side` to `models` * Move `core/base` and `core/sidebase` to dir `modules` * Move `configuration` and `default_config.yaml` to the root of pydolphinscheduler		2 years ago
..
docs	[python] Refactor structure to avoid cycle import (#11167 )	2 years ago
src/pydolphinscheduler	[python] Refactor structure to avoid cycle import (#11167 )	2 years ago
tests	[python] Refactor structure to avoid cycle import (#11167 )	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
.pre-commit-config.yaml	[python] Add autoflake to auto rm unused import (#8897 )	3 years ago
DEVELOP.md	[python] Refactor structure to avoid cycle import (#11167 )	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	[python] Correct some docs for python api (#10772 )	2 years ago
RELEASE.md	[python] Clean deps and prepare release (#8210 )	3 years ago
UPDATING.md	[python] Support read config in env variable (#9517 )	3 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] Refactor structure to avoid cycle import (#11167 )	2 years ago
tox.ini	[python] Add integrated test to python gateway server (#8966 )	3 years ago

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

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