https://github.com/inveniosoftware-contrib/workflow

Simple Pythonic Workflows
https://github.com/inveniosoftware-contrib/workflow

Last synced: 3 months ago
JSON representation

Simple Pythonic Workflows

• Host: GitHub
• URL: https://github.com/inveniosoftware-contrib/workflow
• Owner: inveniosoftware-contrib
• License: other
• Created: 2011-07-08T16:28:36.000Z (over 13 years ago)
• Default Branch: master
• Last Pushed: 2020-02-29T20:05:00.000Z (almost 5 years ago)
• Last Synced: 2024-11-04T23:51:50.467Z (3 months ago)
• Language: Python
• Homepage: https://workflow.readthedocs.io
• Size: 311 KB
• Stars: 152
• Watchers: 51
• Forks: 46
• Open Issues: 12
• Metadata Files:
  • Readme: README.rst
  • Contributing: CONTRIBUTING.rst
  • License: LICENSE

Awesome Lists containing this project

• awesome_ai_agents - Workflow - Simple Pythonic Workflows (Building / Workflows)
• awesome_ai_agents - Workflow - Simple Pythonic Workflows (Building / Workflows)

README

        
==========

 workflow

==========

.. image:: https://travis-ci.org/inveniosoftware-contrib/workflow.png?branch=master

    :target: https://travis-ci.org/inveniosoftware-contrib/workflow

.. image:: https://coveralls.io/repos/github/inveniosoftware-contrib/workflow/badge.svg?branch=master

    :target: https://coveralls.io/github/inveniosoftware-contrib/workflow?branch=master

About

=====

Workflow is a Finite State Machine with memory.  It is used to execute

set of methods in a specified order.

Here is a simple example of a workflow configuration:

.. code-block:: text

    [

      check_token_is_wanted, # (run always)

      [                      # (run conditionally)

         check_token_numeric,

         translate_numeric,

         next_token          # (stop processing, continue with next token)

         ],

      [                      # (run conditionally)

         check_token_proper_name,

         translate_proper_name,

         next_token          # (stop processing, continue with next token)

         ],

      normalize_token,       # (only for "normal" tokens)

      translate_token,

    ]

Documentation

=============

Documentation is readable at http://workflow.readthedocs.io or can be built using Sphinx: ::

    pip install Sphinx

    python setup.py build_sphinx

Installation

============

Workflow is on PyPI so all you need is: ::

    pip install workflow

Testing

=======

Running the test suite is as simple as: ::

    python setup.py test

or, to also show code coverage: ::

    ./run-tests.sh