From 0c1f664884ce0b529b9f9ee118fc4ebbe603efc3 Mon Sep 17 00:00:00 2001 From: Jiajie Zhong Date: Mon, 7 Feb 2022 22:09:28 +0800 Subject: [PATCH] [python][chore] Add pypi related info badge to readme (#8294) --- .../pydolphinscheduler/README.md | 33 ++++++++----------- 1 file changed, 14 insertions(+), 19 deletions(-) diff --git a/dolphinscheduler-python/pydolphinscheduler/README.md b/dolphinscheduler-python/pydolphinscheduler/README.md index dfee43f2cc..9cc524d346 100644 --- a/dolphinscheduler-python/pydolphinscheduler/README.md +++ b/dolphinscheduler-python/pydolphinscheduler/README.md @@ -19,9 +19,15 @@ # pydolphinscheduler -[![GitHub Build][ga-py-test]][ga] -[![Code style: black][black-shield]][black-gh] -[![Imports: isort][isort-shield]][isort-gh] +[![PyPi Version](https://img.shields.io/pypi/v/apache-dolphinscheduler.svg?style=flat-square&logo=PyPi)](https://pypi.org/project/apache-dolphinscheduler/) +[![PyPi Python Versions](https://img.shields.io/pypi/pyversions/apache-dolphinscheduler.svg?style=flat-square&logo=python)](https://pypi.org/project/apache-dolphinscheduler/) +[![PyPi License](https://img.shields.io/pypi/l/apache-dolphinscheduler.svg?style=flat-square)](https://pypi.org/project/apache-dolphinscheduler/) +[![PyPi Status](https://img.shields.io/pypi/status/apache-dolphinscheduler.svg?style=flat-square)](https://pypi.org/project/apache-dolphinscheduler/) +[![PyPi Downloads](https://img.shields.io/pypi/dm/apache-dolphinscheduler?style=flat-square)](https://pypi.org/project/apache-dolphinscheduler/) + +[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black) +[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat-square&labelColor=ef8336)](https://pycqa.github.io/isort) +[![GitHub Build](https://github.com/apache/dolphinscheduler/actions/workflows/py-ci.yml/badge.svg?branch=dev)](https://github.com/apache/dolphinscheduler/actions?query=workflow%3A%22Python+API%22) **PyDolphinScheduler** is python API for Apache DolphinScheduler, which allow you definition your workflow by python code, aka workflow-as-codes. @@ -43,7 +49,8 @@ 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][dev-setup] +Before you run an example, you have to start backend server. You could follow +[development setup](https://dolphinscheduler.apache.org/en-us/development/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 @@ -63,7 +70,8 @@ python ./tutorial.py > 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][ui-project]. +After command execute, you could see a new project with single process definition named *tutorial* in the +[UI-project list](https://dolphinscheduler.apache.org/en-us/docs/latest/user_doc/guide/project/project-list.html). ## Develop @@ -76,17 +84,4 @@ If you are interested in how to release **PyDolphinScheduler**, you could go and ## What's more -For more detail information, please go to see **PyDolphinScheduler** [document][pyds-doc-home] - - -[pypi]: https://pypi.org/ -[dev-setup]: https://dolphinscheduler.apache.org/en-us/development/development-environment-setup.html -[ui-project]: http://8.142.34.29:12345/dolphinscheduler/ui/#/projects/list -[pyds-doc-home]: https://dolphinscheduler.apache.org/python/index.html - -[ga-py-test]: https://github.com/apache/dolphinscheduler/actions/workflows/py-ci.yml/badge.svg?branch=dev -[ga]: https://github.com/apache/dolphinscheduler/actions -[black-shield]: https://img.shields.io/badge/code%20style-black-000000.svg -[black-gh]: https://github.com/psf/black -[isort-shield]: https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat&labelColor=ef8336 -[isort-gh]: https://pycqa.github.io/isort/ +For more detail information, please go to see **PyDolphinScheduler** [document](https://dolphinscheduler.apache.org/python/index.html)