c558da07b6
Update hacking to the new requirements version and
fix about half of the new reported issues. The other
hacking issues are for now ignored until fixed by
adjusting our tox.ini file.
This commit fixes the following new hacking errors:
H405 - multi line docstring summary not separated
with an empty line
E265 - block comment should start with '# '
F402 - import 'endpoint' from line 21 shadowed by
loop variable
Change-Id: I6bae61591fb988cc17fa79e21cb5f1508d22781c
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.
- More information can be found by referring to the developer documentation.
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 file describes several test environments
that allow to test TaskFlow with different python versions and sets of
requirements installed.
To generate the tox.ini file, 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.iniDeveloper documentation
We also have sphinx documentation in docs/source.
To build it, run:
$ python setup.py build_sphinx