A library to complete workflows/tasks in HA manner
Go to file
Takashi Kajinami 43c1da4672 Add note about requirements lower bounds
Since lower constraints job was removed the bounds are not actually
tested. Add a note to explain the bounds are maintained on best effort
basis.

Change-Id: I7f4c52f6a89d5469d1c5f63870c8c42ab0deda38
2024-10-31 09:58:14 +09:00
doc Merge "Add Etcd backend for jobboard" 2024-07-08 04:20:49 +00:00
playbooks/tests/functional Add functional test with etcd 2024-07-05 20:13:33 +09:00
releasenotes Remove Python 3.8 support 2024-10-16 10:33:56 +09:00
taskflow Merge "Fix REVERT_ALL with Retries in unordered Flows" 2024-08-07 13:50:05 +00:00
tools Replace deprecated Engine.execute 2024-04-16 04:59:01 +00:00
.coveragerc coveragerc: Remove non-existent path 2023-12-19 20:56:21 +09:00
.gitignore Add functional test with etcd 2024-07-05 20:13:33 +09:00
.gitreview OpenDev Migration Patch 2019-04-19 19:30:55 +00:00
.mailmap Remap the emails of the committers 2013-09-17 13:27:27 -07:00
.pre-commit-config.yaml Bump hacking 2024-01-28 16:04:41 +09:00
.stestr.conf Switch to use stestr for unit test 2018-08-13 16:20:18 -04:00
.zuul.yaml Merge "Add functional test with etcd" 2024-07-08 04:20:51 +00:00
bindep.txt Add functional job with redis enabled 2024-04-15 19:43:06 +09:00
CONTRIBUTING.rst Updating for OFTC IRC network 2021-06-07 20:43:11 +00:00
LICENSE Move the code over for now 2013-05-07 10:49:44 -07:00
pylintrc Fix a couple of spelling and grammar errors 2015-03-29 03:11:08 +11:00
README.rst update git.openstack.org to opendev 2019-05-22 09:51:19 +01:00
requirements.txt Add note about requirements lower bounds 2024-10-31 09:58:14 +09:00
run_tests.sh Switch to just using tox 2014-01-02 10:38:15 -08:00
setup-etcd-env.sh Add functional test with etcd 2024-07-05 20:13:33 +09:00
setup.cfg Remove Python 3.8 support 2024-10-16 10:33:56 +09:00
setup.py Cleanup setup.py and requirements 2024-01-12 17:55:09 +09:00
test-requirements.txt Merge "Add Etcd backend for jobboard" 2024-07-08 04:20:49 +00:00
tox.ini Drop SQLALCHEMY_WARN_20 2024-09-16 15:27:10 +09:00

Team and repository tags

image

TaskFlow

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.

Join us

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