2f78ecf1cc
The oslo repositories are standardizing on a common set of links to include in README.rst (which the release note script will also use); so therefore we should add our own set to match those other projects. Change-Id: I58cbcd9b36fd0432b59e9eec3ad5ab54a1fede3a
56 lines
1.7 KiB
ReStructuredText
56 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.
|
|
|
|
* 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
|
|
-------
|
|
|
|
- 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 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
|
|
|
|
.. _tox: http://testrun.org/tox/latest/
|
|
.. _developer documentation: http://docs.openstack.org/developer/taskflow/
|