openstack/taskflow
Code Issues Proposed changes
A library to complete workflows/tasks in HA manner
755 Commits 6 Branches 41 Tags 32 MiB
Python 99.3%
Shell 0.7%
37ec87fdcf
Go to file
Ivan A. Melnikov 37ec87fdcf docs: Relative links improvements 
- replace two separate blocks for previous and next chapter on side
  bar with common 'Navigation' block;
- add link to table of contents to the block, as it's not that easy
  to find one in current layout.

Change-Id: Iabb191fa94ac9bcb061db8e90d69c87525965527
2014-03-13 12:05:57 +04:00
doc/source docs: Relative links improvements 2014-03-13 12:05:57 +04:00
taskflow Merge "Move endpoint subclass finding to reflection util" 2014-03-13 02:59:25 +00:00
tools Use the released toxgen tool instead of our copy 2014-01-12 08:01:50 -08: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 Prepare for 0.1 release 2013-10-14 01:03:32 +00: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 Get rid of openstack.common.py3kcompat 2014-03-03 12:28:54 +04:00
optional-requirements.txt Message-oriented worker-based flow with kombu 2014-02-19 14:47:34 +02:00
pylintrc Remove error code not found in strict version of pylint. 2013-05-22 18:19:45 -07:00
README.md Rework sphinx documentation 2014-02-14 16:25:15 +04:00
requirements.txt Updated from global requirements 2014-03-11 17:37:21 +00:00
run_tests.sh Switch to just using tox 2014-01-02 10:38:15 -08:00
setup.cfg Merge "Message-oriented worker-based flow with kombu" 2014-02-20 11:11:01 +00:00
setup.py Bump requirements to the latest 2013-10-05 21:49:08 +00:00
test-requirements.txt Updated from global requirements 2014-02-23 09:32:52 +00:00
tox-tmpl.ini Fix command for pylint tox env 2014-02-17 14:41:37 +02:00
tox.ini Message-oriented worker-based flow with kombu 2014-02-19 14:47:34 +02:00

README.md

TaskFlow

A library to do [jobs, tasks, flows] in a HA manner using different backends to be used with OpenStack 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 to requirements.txt;
  • things that are required by some optional part of TaskFlow (you can use TaskFlow without them) are put to 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 to test-requirements.txt.

Tox.ini

Our tox.ini describes several test environments that allow to test TaskFlow with different python versions and sets of requirements installed.

To generate tox.ini, use the toxgen.py script by first installing toxgen and then provide that script as input the tox-tmpl.ini file to generate the final tox.ini file.

For example:

$ toxgen.py -i tox-tmpl.ini -o tox.ini

Documentation

http://wiki.openstack.org/wiki/TaskFlow

We also have sphinx documentation in docs/source. To build it, run:

$ python ./setup.py build_sphinx