========================
Team and repository tags
========================
.. image:: https://governance.openstack.org/tc/badges/taskflow.svg
:target: https://governance.openstack.org/tc/reference/tags/index.html
.. Change things from this point on
TaskFlow
========
.. image:: https://img.shields.io/pypi/v/taskflow.svg
:target: https://pypi.org/project/taskflow/
:alt: Latest Version
A library to do [jobs, tasks, flows] in a highly available, easy to understand
and declarative manner (and more!) to be used with OpenStack and other
projects.
* Free software: Apache license
* Documentation: https://docs.openstack.org/taskflow/latest/
* Source: https://opendev.org/openstack/taskflow
* Bugs: https://bugs.launchpad.net/taskflow/
* Release notes: https://docs.openstack.org/releasenotes/taskflow/
Join us
-------
- https://launchpad.net/taskflow
Testing and requirements
------------------------
Requirements
~~~~~~~~~~~~
Because this project has many optional (pluggable) parts like persistence
backends and engines, we decided to split our requirements into two
parts: - things that are absolutely required (you can't use the project
without them) are put into ``requirements.txt``. The requirements
that are required by some optional part of this project (you can use the
project without them) are put into our ``test-requirements.txt`` file (so
that we can still test the optional functionality works as expected). If
you want to use the feature in question (`eventlet`_ or the worker based engine
that uses `kombu`_ or the `sqlalchemy`_ persistence backend or jobboards which
have an implementation built using `kazoo`_ ...), you should add
that requirement(s) to your project or environment.
Tox.ini
~~~~~~~
Our ``tox.ini`` file describes several test environments that allow to test
TaskFlow with different python versions and sets of requirements installed.
Please refer to the `tox`_ documentation to understand how to make these test
environments work for you.
Developer documentation
-----------------------
We also have sphinx documentation in ``docs/source``.
*To build it, run:*
::
$ python setup.py build_sphinx
.. _kazoo: https://kazoo.readthedocs.io/en/latest/
.. _sqlalchemy: https://www.sqlalchemy.org/
.. _kombu: https://kombu.readthedocs.io/en/latest/
.. _eventlet: http://eventlet.net/
.. _tox: https://tox.testrun.org/
Raw data
{
"_id": null,
"home_page": "https://docs.openstack.org/taskflow/latest/",
"name": "taskflow",
"maintainer": null,
"docs_url": "https://pythonhosted.org/taskflow/",
"requires_python": ">=3.8",
"maintainer_email": null,
"keywords": "reliable, tasks, execution, parallel, dataflow, workflows, distributed",
"author": "OpenStack",
"author_email": "openstack-discuss@lists.openstack.org",
"download_url": "https://files.pythonhosted.org/packages/94/6b/d5ed34f1b28b21d766aee9afd078e0418a8b56a89c29d552d0f8afc4d05f/taskflow-5.7.0.tar.gz",
"platform": null,
"description": "========================\nTeam and repository tags\n========================\n\n.. image:: https://governance.openstack.org/tc/badges/taskflow.svg\n :target: https://governance.openstack.org/tc/reference/tags/index.html\n\n.. Change things from this point on\n\nTaskFlow\n========\n\n.. image:: https://img.shields.io/pypi/v/taskflow.svg\n :target: https://pypi.org/project/taskflow/\n :alt: Latest Version\n\nA library to do [jobs, tasks, flows] in a highly available, easy to understand\nand declarative manner (and more!) to be used with OpenStack and other\nprojects.\n\n* Free software: Apache license\n* Documentation: https://docs.openstack.org/taskflow/latest/\n* Source: https://opendev.org/openstack/taskflow\n* Bugs: https://bugs.launchpad.net/taskflow/\n* Release notes: https://docs.openstack.org/releasenotes/taskflow/\n\nJoin us\n-------\n\n- https://launchpad.net/taskflow\n\nTesting and requirements\n------------------------\n\nRequirements\n~~~~~~~~~~~~\n\nBecause this project has many optional (pluggable) parts like persistence\nbackends and engines, we decided to split our requirements into two\nparts: - things that are absolutely required (you can't use the project\nwithout them) are put into ``requirements.txt``. The requirements\nthat are required by some optional part of this project (you can use the\nproject without them) are put into our ``test-requirements.txt`` file (so\nthat we can still test the optional functionality works as expected). If\nyou want to use the feature in question (`eventlet`_ or the worker based engine\nthat uses `kombu`_ or the `sqlalchemy`_ persistence backend or jobboards which\nhave an implementation built using `kazoo`_ ...), you should add\nthat requirement(s) to your project or environment.\n\nTox.ini\n~~~~~~~\n\nOur ``tox.ini`` file describes several test environments that allow to test\nTaskFlow with different python versions and sets of requirements installed.\nPlease refer to the `tox`_ documentation to understand how to make these test\nenvironments work for you.\n\nDeveloper documentation\n-----------------------\n\nWe also have sphinx documentation in ``docs/source``.\n\n*To build it, run:*\n\n::\n\n $ python setup.py build_sphinx\n\n.. _kazoo: https://kazoo.readthedocs.io/en/latest/\n.. _sqlalchemy: https://www.sqlalchemy.org/\n.. _kombu: https://kombu.readthedocs.io/en/latest/\n.. _eventlet: http://eventlet.net/\n.. _tox: https://tox.testrun.org/\n\n\n\n",
"bugtrack_url": null,
"license": null,
"summary": "Taskflow structured state management library.",
"version": "5.7.0",
"project_urls": {
"Homepage": "https://docs.openstack.org/taskflow/latest/"
},
"split_keywords": [
"reliable",
" tasks",
" execution",
" parallel",
" dataflow",
" workflows",
" distributed"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "2bca3f241ed514b2995393d14e6fa7e452c5cde4a207033eab964d4e3901f96e",
"md5": "5b9c7b8bc1441f5bf55d35aae37d1407",
"sha256": "4e9f7e290699062232c6550a394a8aec820d963ce8d9a65b96c7344472acf881"
},
"downloads": -1,
"filename": "taskflow-5.7.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "5b9c7b8bc1441f5bf55d35aae37d1407",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8",
"size": 494404,
"upload_time": "2024-04-18T10:24:43",
"upload_time_iso_8601": "2024-04-18T10:24:43.475137Z",
"url": "https://files.pythonhosted.org/packages/2b/ca/3f241ed514b2995393d14e6fa7e452c5cde4a207033eab964d4e3901f96e/taskflow-5.7.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "946bd5ed34f1b28b21d766aee9afd078e0418a8b56a89c29d552d0f8afc4d05f",
"md5": "ead1fda52b70b274e5668aa14686f1db",
"sha256": "31643cb54bc878d7099a6d4d4b7f9d5f9f7bb5c7ae75a928a21bbb9421d03f4f"
},
"downloads": -1,
"filename": "taskflow-5.7.0.tar.gz",
"has_sig": false,
"md5_digest": "ead1fda52b70b274e5668aa14686f1db",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8",
"size": 1079619,
"upload_time": "2024-04-18T10:24:45",
"upload_time_iso_8601": "2024-04-18T10:24:45.557941Z",
"url": "https://files.pythonhosted.org/packages/94/6b/d5ed34f1b28b21d766aee9afd078e0418a8b56a89c29d552d0f8afc4d05f/taskflow-5.7.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-04-18 10:24:45",
"github": false,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"lcname": "taskflow"
}
JSON