d565cf1a0b
html_last_updated_fmt option is interpreted as a byte string in python3, causing Sphinx build to break. This patch makes it utf-8 string. Changing Popen to .check_output because of 3 reasons: 1. check_output() will raise CalledProcessError if the called process returns a non-zero return code. 2. For consistency with keystone [1] and cinder [2] 3. It makes the code look much better. [1] https://review.openstack.org/#/c/457142/ [2] https://review.openstack.org/#/c/433081 Change-Id: I6e9c2009f224abc282acbf957d7e999c7f87e9eb |
||
---|---|---|
doc | ||
releasenotes | ||
taskflow | ||
tools | ||
.coveragerc | ||
.gitignore | ||
.gitreview | ||
.mailmap | ||
.testr.conf | ||
CONTRIBUTING.rst | ||
LICENSE | ||
README.rst | ||
pylintrc | ||
requirements.txt | ||
run_tests.sh | ||
setup.cfg | ||
setup.py | ||
tox.ini |
README.rst
Team and repository tags
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.
- Free software: Apache license
- Documentation: http://docs.openstack.org/developer/taskflow
- Source: http://git.openstack.org/cgit/openstack/taskflow
- Bugs: http://bugs.launchpad.net/taskflow/
Join us
Testing and requirements
Requirements
Because this project has many optional (pluggable) parts like
persistence backends and engines, we decided to split our requirements
into two parts: - things that are absolutely required (you can't use the
project without them) are put into requirements.txt
. The
requirements that are required by some optional part of this project
(you can use the project without them) are put into our
test-requirements.txt
file (so that we can still test the
optional functionality works as expected). If you want to use the
feature in question (eventlet or the
worker based engine that uses kombu or the sqlalchemy persistence backend or
jobboards which have an implementation built using kazoo ...), you should add that
requirement(s) to your project or environment.
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