openstack/taskflow
Code Issues Proposed changes
A library to complete workflows/tasks in HA manner
1,301 Commits 6 Branches 39 Tags 32 MiB
Python 99.3%
Shell 0.7%
c90e36020a
Go to file
Joshua Harlow c90e36020a Add the database schema to the sqlalchemy docs 
In order to show people that are reading the docs what the current
schema for the database is create a helper tool that upgrades the
schema to the newest version and then uses tabulate to create a
restructured text version of that schema which is then included in
the documentation.

Change-Id: Id215f88430971a4a083f9739fb2ec59d971dc8fa
2014-10-10 06:24:39 +00:00
doc Add the database schema to the sqlalchemy docs 2014-10-10 06:24:39 +00:00
taskflow Avoid usage of six.moves in local functions 2014-10-04 21:41:05 -07:00
tools Add the database schema to the sqlalchemy docs 2014-10-10 06:24:39 +00: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 Switch to using oslo.utils and oslo.serialization 2014-09-20 09:03:11 -07: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 Updated from global requirements 2014-09-29 21:05:26 +00:00
requirements-py3.txt Updated from global requirements 2014-09-29 21:05:26 +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-29 21:05:26 +00:00
tox.ini Avoid usage of six.moves in local functions 2014-10-04 21:41:05 -07: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