c2731a84ec
To make the README file showup in a more readable manner on pypi and on other external sites convert the README from the markdown format and move it to the restructuredtext format which displays better on those external sites (and keeps our documentation consistently one format). Change-Id: I38f7152c264bbc0ebcf4a539b36f8b21e86705b8
60 lines
1.7 KiB
ReStructuredText
60 lines
1.7 KiB
ReStructuredText
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
|
||
-------
|
||
|
||
- http://launchpad.net/taskflow
|
||
|
||
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.ini
|
||
|
||
Developer documentation
|
||
-----------------------
|
||
|
||
We also have sphinx documentation in ``docs/source``.
|
||
|
||
*To build it, run:*
|
||
|
||
::
|
||
|
||
$ python setup.py build_sphinx
|
||
|
||
.. _toxgen: https://pypi.python.org/pypi/toxgen/
|
||
.. _developer documentation: http://docs.openstack.org/developer/taskflow/
|