taskflow/README.rst
Joshua Harlow 3465e0340b Reduce unused tox environments
Since the openstack-ci only tests 5 of the many tox enviroments
we had listed and from my knowledge nobody else is testing using
those other non-standard enviroments just reduce the set of applicable
environments to the ones that are being used (which also means we
can remove the usage of toxgen and just stick with a simpler file
that is easier to use, modify and adjust).

Change-Id: I4d2302594b9f9e8741f9693cb358efc1418bd45d
2014-09-09 10:36:55 -07:00

1.6 KiB

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