openstack/taskflow
Code Issues Proposed changes
A library to complete workflows/tasks in HA manner
1,261 Commits 6 Branches 41 Tags 32 MiB
Python 99.3%
Shell 0.7%
b5e3fbebc6
Go to file
Joshua Harlow b5e3fbebc6 Expand toctree to three levels 
Three levels makes it easier to find content in the
main toctree so lets make it easier for folks to use
the table of contents to find what they are looking for
instead of making it harder...

This change makes three levels look readable as well as
fixes some discrepancies among the various sections...

Change-Id: I5fd7a062adec052c338790c9ba343dfbc51075e3
2014-09-25 00:10:41 -07:00
doc Expand toctree to three levels 2014-09-25 00:10:41 -07:00
taskflow Documentation cleanups and tweaks 2014-09-23 15:16:13 -07:00
tools Color some of the states depending on there meaning 2014-09-20 20:39:13 -07:00
.coveragerc Coverage calculation improvements 2013-11-22 11:25:03 +04:00
.gitignore Merge "Ignore doc build files" 2014-01-07 18:10:43 +00:00
.gitreview Update .gitreview after repo rename 2014-02-07 20:45:32 +00:00
.mailmap Remap the emails of the committers 2013-09-17 13:27:27 -07:00
.testr.conf Fix up python 3.3 incompatabilities 2013-11-21 18:38:44 +04:00
CONTRIBUTING.rst Fix the section name in CONTRIBUTING.rst 2014-07-01 15:51:01 +08:00
LICENSE Move the code over for now 2013-05-07 10:49:44 -07:00
MANIFEST.in Move to using pbr. 2013-07-07 21:46:32 -07:00
openstack-common.conf Synced jsonutils from oslo-incubator 2014-05-27 12:23:36 +02:00
optional-requirements.txt warn against sorting requirements 2014-09-05 05:34:14 +00:00
pylintrc Remove error code not found in strict version of pylint. 2013-05-22 18:19:45 -07:00
README.rst Reduce unused tox environments 2014-09-09 10:36:55 -07:00
requirements-py2.txt Update the requirements-py2.txt file 2014-09-20 08:29:33 -07:00
requirements-py3.txt Merge "Remove the dependency on prettytable" 2014-09-20 14:02:02 +00:00
run_tests.sh Switch to just using tox 2014-01-02 10:38:15 -08:00
setup.cfg Switch to a restructuredtext README file 2014-06-08 20:57:37 -07:00
setup.py Updated from global requirements 2014-05-01 12:43:52 +00:00
test-requirements.txt Updated from global requirements 2014-09-19 08:52:11 +00:00
tox.ini Merge "Add a docs virtualenv" 2014-09-21 13:36:25 +00:00

README.rst

TaskFlow

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 TaskFlow has many optional (pluggable) parts like persistence backends and engines, we decided to split our requirements into two parts: - things that are absolutely required by TaskFlow (you can't use TaskFlow without them) are put into requirements-pyN.txt (N being the Python major version number used to install the package); - things that are required by some optional part of TaskFlow (you can use TaskFlow without them) are put into optional-requirements.txt; if you want to use the feature in question, you should add that requirements to your project or environment; - as usual, things that required only for running tests are put into test-requirements.txt.

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