{"id":14988001,"url":"https://github.com/apache/dolphinscheduler-sdk-python","last_synced_at":"2025-04-05T01:05:49.925Z","repository":{"id":64708165,"uuid":"562819934","full_name":"apache/dolphinscheduler-sdk-python","owner":"apache","description":"Apache DolphinScheduler Python API, aka PyDolphinscheduler.","archived":false,"fork":false,"pushed_at":"2025-01-22T09:51:27.000Z","size":557,"stargazers_count":54,"open_issues_count":25,"forks_count":20,"subscribers_count":19,"default_branch":"main","last_synced_at":"2025-03-29T00:11:58.534Z","etag":null,"topics":["api","dolphinscheduler","python","workflow"],"latest_commit_sha":null,"homepage":"https://dolphinscheduler.apache.org/python/main","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/apache.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2022-11-07T10:27:11.000Z","updated_at":"2025-02-24T02:26:23.000Z","dependencies_parsed_at":"2023-02-01T05:46:00.488Z","dependency_job_id":"3029176c-13e2-4530-ba3d-580ff08e9ddc","html_url":"https://github.com/apache/dolphinscheduler-sdk-python","commit_stats":{"total_commits":86,"total_committers":7,"mean_commits":"12.285714285714286","dds":"0.10465116279069764","last_synced_commit":"2b69a74cc83efe403f59d3b7768ac18ff4e08319"},"previous_names":[],"tags_count":17,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fdolphinscheduler-sdk-python","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fdolphinscheduler-sdk-python/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fdolphinscheduler-sdk-python/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/apache%2Fdolphinscheduler-sdk-python/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/apache","download_url":"https://codeload.github.com/apache/dolphinscheduler-sdk-python/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247271528,"owners_count":20911587,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["api","dolphinscheduler","python","workflow"],"created_at":"2024-09-24T14:15:56.310Z","updated_at":"2025-04-05T01:05:49.896Z","avatar_url":"https://github.com/apache.png","language":"Python","funding_links":[],"categories":["Python"],"sub_categories":[],"readme":"\u003c!--\nLicensed to the Apache Software Foundation (ASF) under one\nor more contributor license agreements.  See the NOTICE file\ndistributed with this work for additional information\nregarding copyright ownership.  The ASF licenses this file\nto you under the Apache License, Version 2.0 (the\n\"License\"); you may not use this file except in compliance\nwith the License.  You may obtain a copy of the License at\n\nhttp://www.apache.org/licenses/LICENSE-2.0\n\nUnless required by applicable law or agreed to in writing,\nsoftware distributed under the License is distributed on an\n\"AS IS\" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY\nKIND, either express or implied.  See the License for the\nspecific language governing permissions and limitations\nunder the License.\n--\u003e\n\n# PyDolphinScheduler\n\n[![PyPi Version](https://img.shields.io/pypi/v/apache-dolphinscheduler.svg?style=flat-square\u0026logo=PyPi)](https://pypi.org/project/apache-dolphinscheduler/)\n[![PyPi Python Versions](https://img.shields.io/pypi/pyversions/apache-dolphinscheduler.svg?style=flat-square\u0026logo=python)](https://pypi.org/project/apache-dolphinscheduler/)\n[![PyPi License](https://img.shields.io/:license-Apache%202-blue.svg?style=flat-square)](https://raw.githubusercontent.com/apache/dolphinscheduler-sdk-python/main/LICENSE)\n[![PyPi Status](https://img.shields.io/pypi/status/apache-dolphinscheduler.svg?style=flat-square)](https://pypi.org/project/apache-dolphinscheduler/)\n[![Downloads](https://static.pepy.tech/badge/apache-dolphinscheduler/month)](https://pepy.tech/project/apache-dolphinscheduler)\n![Coverage Status](https://img.shields.io/codecov/c/github/apache/dolphinscheduler-sdk-python/main.svg?style=flat-square)\n[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg?style=flat-square)](https://github.com/psf/black)\n[![Imports: isort](https://img.shields.io/badge/%20imports-isort-%231674b1?style=flat-square\u0026labelColor=ef8336)](https://pycqa.github.io/isort)\n[![CI](https://github.com/apache/dolphinscheduler-sdk-python/actions/workflows/ci.yaml/badge.svg)](https://github.com/apache/dolphinscheduler-sdk-python/actions/workflows/ci.yaml)\n[![Twitter Follow](https://img.shields.io/twitter/follow/dolphinschedule.svg?style=social\u0026label=Follow)](https://twitter.com/dolphinschedule)\n[![Slack Status](https://img.shields.io/badge/slack-join_chat-white.svg?logo=slack\u0026style=social)](https://s.apache.org/dolphinscheduler-slack)\n\n**PyDolphinScheduler** is python API for [Apache DolphinScheduler](https://dolphinscheduler.apache.org),\nwhich allow you definition your workflow by python code, aka workflow-as-codes.\n\n## Quick Start\n\n### Version Compatibility\n\nAt Nov 7, 2022 we seperated PyDolphinScheduler from DolphinScheduler, and the version of PyDolphinScheduler 4.0.0\ncan match multiple versions of DolphinScheduler, for more details, please refer to [version](https://dolphinscheduler.apache.org/python/main/index.html#version)\n\n### Installation\n\n```shell\n# Install\npython -m pip install apache-dolphinscheduler\n\n# Verify installation is successful, it will show the version of apache-dolphinscheduler, here we use 0.1.0 as example\npydolphinscheduler version\n# 0.1.0\n```\n\n\u003e NOTE: package apache-dolphinscheduler not work on above Python version 3.10(including itself) in Window operating system\n\u003e due to dependence [py4j](https://pypi.org/project/py4j/) not work on those environments.\n\nHere we show you how to install and run a simple example of PyDolphinScheduler\n\n### Start DolphinScheduler\n\nThere are many ways to start DolphinScheduler, here we use docker to start and run it as a standalone server.\n\n```shell\n# Change the version of dolphinscheduler to the version you want to use, here we use 3.1.1 as example\nDOLPHINSCHEDULER_VERSION=3.1.1\ndocker run --name dolphinscheduler-standalone-server -p 12345:12345 -p 25333:25333 -e API_PYTHON_GATEWAY_ENABLED=\"true\" -d apache/dolphinscheduler-standalone-server:\"${DOLPHINSCHEDULER_VERSION}\"\n```\n\nAfter the container is started, you can access the DolphinScheduler UI via http://localhost:12345/dolphinscheduler.\nFor more way to start DolphinScheduler and the more detail about DolphinScheduler, please refer to\n[DolphinScheduler](https://dolphinscheduler.apache.org/#/en-us/docs/3.1.2/guide/start/quick-start)\n\n### Run a simple example\n\nWe have many examples in [examples](src/pydolphinscheduler/examples) directory, we here pick up a typical one\nto show how to run it.\n\n```shell\n# Get the latest code of example from github \ncurl https://raw.githubusercontent.com/apache/dolphinscheduler-sdk-python/main/src/pydolphinscheduler/examples/tutorial.py -o ./tutorial.py\n\n# Change tenant to real exists tenant in the host your DolphinScheduler running, by any editor you like \n\n# Run the example\npython ./tutorial.py\n```\n\n\u003e NOTICE: Since Apache DolphinScheduler's tenant is requests while running command, you have to change\n\u003e tenant value in file tutorial.py. The default value is `tenant_exists`, change it to username exists your host.\n\nAfter that, a new workflow will be created by PyDolphinScheduler, and you can see it in DolphinScheduler web\nUI's Project Management page. It will trigger the workflow automatically, so you can see the workflow running\nin DolphinScheduler web UI's Workflow Instance page too. For more detail about any function about DolphinScheduler\nProject Management, please refer to [DolphinScheduler Workflow](https://dolphinscheduler.apache.org/#/en-us/docs/3.1.2/guide/project/workflow-definition)\n\n## Documentation\n\nFor full documentation visit [document](https://dolphinscheduler.apache.org/python/main/index.html). This\ndocumentation is generated from this repository so please raise issues or pull requests for any additions, corrections, or clarifications.\n\n## Contributing\n\nIf you would like to contribute, check out the [open issues on GitHub](https://github.com/apache/dolphinscheduler-sdk-python/issues).\nYou can also see the guide to [contributing](./CONTRIBUTING.md).\n\n## Release\n\nFollow the [release](./RELEASE.md) guide to release a new version of PyDolphinScheduler.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fdolphinscheduler-sdk-python","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fapache%2Fdolphinscheduler-sdk-python","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fapache%2Fdolphinscheduler-sdk-python/lists"}