openstack/taskflow
Code Issues Proposed changes

README updates

Browse Source 
This was full of old or irrelevant information. Update it.

Change-Id: I95a2d79bf71306b865b63ee24877c86c08f270c9
Signed-off-by: Stephen Finucane <stephenfin@redhat.com>
This commit is contained in:
Stephen Finucane
2026-03-11 11:09:41 +00:00
parent b26e57d1b9
commit 4368f07268
1 changed files with 15 additions and 34 deletions
Download Patch File Download Diff File Expand all files Collapse all files

49
README.rst
View File

@@ -23,50 +23,31 @@ projects.
* Bugs: https://bugs.launchpad.net/taskflow/
* Release notes: https://docs.openstack.org/releasenotes/taskflow/
Join us
-------
Installation
------------
- https://launchpad.net/taskflow
The library can be installed from PyPI:
Testing and requirements
------------------------
.. code-block:: shell
Requirements
~~~~~~~~~~~~
pip install taskflow
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.
parts: - things that are absolutely required (you can't use the project without
them) and things that are required by some optional part of this project (you
can use the project without them). The latter requirements are provided by
extras. If you want to use the feature in question, such as the worker-based
engine that uses `kombu`_, the `sqlalchemy`_ persistence backend or jobboards
which have an implementation built using `kazoo`_, you should add that
requirement(s) to your project or environment. For examples, to install the
worked-based engine:
Tox.ini
~~~~~~~
.. code-block:: shell
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
pip install taskflow[workers]
.. _kazoo: https://kazoo.readthedocs.io/en/latest/
.. _sqlalchemy: https://www.sqlalchemy.org/
.. _kombu: https://kombu.readthedocs.io/en/latest/
.. _eventlet: http://eventlet.net/
.. _tox: https://tox.testrun.org/