This is an automated email from the ASF dual-hosted git repository.
zhongjiajie pushed a commit to branch main
in repository
https://gitbox.apache.org/repos/asf/dolphinscheduler-sdk-python.git
The following commit(s) were added to refs/heads/main by this push:
new baf6402 [chore] Correct badge license and change download to
pypy.tech (#32)
baf6402 is described below
commit baf6402cc9d98fb4e9f056b96687d7828615ff8e
Author: Jay Chung <[email protected]>
AuthorDate: Fri Nov 25 23:38:34 2022 +0800
[chore] Correct badge license and change download to pypy.tech (#32)
* Correct badge license and change download to pypy.tech
* Correct badge and flush README.md
---
README.md | 70 ++++++++++++++++++++++++++++++++++++++-------------------------
setup.py | 2 +-
2 files changed, 43 insertions(+), 29 deletions(-)
diff --git a/README.md b/README.md
index 877934b..fcdc944 100644
--- a/README.md
+++ b/README.md
@@ -17,20 +17,22 @@ specific language governing permissions and limitations
under the License.
-->
-# pydolphinscheduler
+# PyDolphinScheduler
[](https://pypi.org/project/apache-dolphinscheduler/)
[](https://pypi.org/project/apache-dolphinscheduler/)
-[](https://pypi.org/project/apache-dolphinscheduler/)
+[](https://raw.githubusercontent.com/apache/dolphinscheduler-sdk-python/main/LICENSE)
[](https://pypi.org/project/apache-dolphinscheduler/)
-[](https://pypi.org/project/apache-dolphinscheduler/)
+[](https://pepy.tech/project/apache-dolphinscheduler)
[](https://codecov.io/github/apache/dolphinscheduler-sdk-python?branch=main)
[](https://github.com/psf/black)
[](https://pycqa.github.io/isort)
[](https://github.com/apache/dolphinscheduler-sdk-python/actions/workflows/ci.yaml)
+[](https://twitter.com/dolphinschedule)
+[](https://s.apache.org/dolphinscheduler-slack)
-**PyDolphinScheduler** is python API for Apache DolphinScheduler, which allow
you definition
-your workflow by python code, aka workflow-as-codes.
+**PyDolphinScheduler** is python API for [Apache
DolphinScheduler](https://dolphinscheduler.apache.org/en-us/index.html),
+which allow you definition your workflow by python code, aka workflow-as-codes.
## Quick Start
@@ -53,43 +55,55 @@ pydolphinscheduler version
> NOTE: package apache-dolphinscheduler not work on above Python version
> 3.10(including itself) in Window operating system
> due to dependence [py4j](https://pypi.org/project/py4j/) not work on those
> environments.
-Here we show you how to install and run a simple example of pydolphinscheduler
+Here we show you how to install and run a simple example of PyDolphinScheduler
-### Start Server And Run Example
+### Start DolphinScheduler
-Before you run an example, you have to start backend server. You could follow
-[development
setup](https://dolphinscheduler.apache.org/en-us/docs/dev/user_doc/contribute/development-environment-setup.html)
-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
+There are many ways to start DolphinScheduler, here we use docker to start and
run it as a standalone server.
-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:
+```shell
+# Change the version of dolphinscheduler to the version you want to use, here
we use 3.1.1 as example
+DOLPHINSCHEDULER_VERSION=3.1.1
+docker run --name dolphinscheduler-standalone-server -p 12345:12345 -p
25333:25333 -d
apache/dolphinscheduler-standalone-server:"${DOLPHINSCHEDULER_VERSION}"
+```
+
+After the container is started, you can access the DolphinScheduler UI via
http://localhost:12345/dolphinscheduler.
+For more way to start DolphinScheduler and the more detail about
DolphinScheduler, please refer to
+[DolphinScheduler](https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/about/introduction.html)
+
+### Run a simple example
-<!-- TODO Add examples directory to dist package later. -->
+We have many examples in [examples](src/pydolphinscheduler/examples)
directory, we here pick up a typical one
+to show how to run it.
```shell
-# Please make sure your terminal could
+# Get the latest code of example from github
curl
https://raw.githubusercontent.com/apache/dolphinscheduler-sdk-python/main/src/pydolphinscheduler/examples/tutorial.py
-o ./tutorial.py
+
+# Change tenant to real exists tenant in the host your DolphinScheduler
running, by any editor you like
+
+# Run the example
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.
+> NOTICE: Since Apache DolphinScheduler's tenant is requests while running
command, you have to change
+> tenant value in tutorial.py`. The default value is `tenant_exists`, change
it to username exists your host.
-After command execute, you could see a new project with single workflow named
*tutorial* in the
-[UI-project
list](https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/guide/project/project-list.html).
+After that, a new workflow will be created by PyDolphinScheduler, and you can
see it in DolphinScheduler web
+UI's Project Management page. It will trigger the workflow automatically, so
you can see the workflow running
+in DolphinScheduler web UI's Workflow Instance page too. For more detail about
any function about DolphinScheduler
+Project Management, please refer to [DolphinScheduler Project
Management](https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/guide/project/project-list.html)
-## Develop
+## Documentation
-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](./CONTRIBUTING.md) section.
+For full documentation visit
[document](https://dolphinscheduler.apache.org/python/main/index.html). This
+documentation is generated from this repository so please raise issues or pull
requests for any additions, corrections, or clarifications.
-## Release
+## Contributing
-If you are interested in how to release **PyDolphinScheduler**, you could go
and see at [release](./RELEASE.md)
+If you would like to contribute, check out the [open issues on
GitHub](https://github.com/apache/dolphinscheduler-sdk-python/issues).
+You can also see the guide to [contributing](./CONTRIBUTING.md).
-## What's more
+## Release
-For more detail information, please go to see **PyDolphinScheduler**
latest(unreleased)
[document](https://dolphinscheduler.apache.org/python/main/index.html)
+Follow the [release](./RELEASE.md) guide to release a new version of
PyDolphinScheduler.
diff --git a/setup.py b/setup.py
index 85a45c0..6d926a1 100644
--- a/setup.py
+++ b/setup.py
@@ -132,7 +132,7 @@ setup(
long_description_content_type="text/markdown",
author="Apache Software Foundation",
author_email="[email protected]",
- url="https://dolphinscheduler.apache.org/";,
+ url="https://dolphinscheduler.apache.org/python/main/index.html";,
python_requires=">=3.6",
keywords=[
"dolphinscheduler",
