openstack/taskflow
Code Issues Proposed changes
A library to complete workflows/tasks in HA manner
935 Commits 6 Branches 41 Tags 32 MiB
Python 99.3%
Shell 0.7%
7f6ef479c1
Go to file
Joshua Harlow 7f6ef479c1 Add a resumption strategy doc 
Move docs from wiki to developer docs and
add on and adjust to reflect the current
state of things.

Change-Id: I50ab1ebeb33074d1fbc7493749d0d518b66de69e
2014-04-26 18:09:37 -07:00
doc/source Add a resumption strategy doc 2014-04-26 18:09:37 -07:00
taskflow Add last_modified & created_on attributes to jobs 2014-04-21 18:43:29 -07:00
tools Add a directed graph type (new types module) 2014-04-20 17:28:27 -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 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 import run_cross_tests.sh from incubator 2014-04-04 06:43:25 -07:00
optional-requirements.txt SQLAlchemy requirements put in order 2014-03-26 14:35:22 +04: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-04-20 09:59:58 +00:00
run_tests.sh Switch to just using tox 2014-01-02 10:38:15 -08:00
setup.cfg Allow fetching jobboard implementations 2014-04-15 14:48:35 -07:00
setup.py Bump requirements to the latest 2013-10-05 21:49:08 +00:00
test-requirements.txt Use sequencing when posting jobs 2014-04-21 18:38:31 -07:00
tox-tmpl.ini SQLAlchemy requirements put in order 2014-03-26 14:35:22 +04:00
tox.ini SQLAlchemy requirements put in order 2014-03-26 14:35:22 +04: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