Skip to content

Commit

Permalink
README: Python 3 note removal
Browse files Browse the repository at this point in the history
* Adds classifiers for Python versions 2.6, 2.7, and 3.3.

Reported-by: Tibor Simko <[email protected]>
Signed-off-by: Jiri Kuncar <[email protected]>
  • Loading branch information
jirikuncar committed Aug 26, 2014
1 parent c10f529 commit b35b0df
Show file tree
Hide file tree
Showing 2 changed files with 24 additions and 23 deletions.
40 changes: 20 additions & 20 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -65,10 +65,11 @@ Example:
def next_token(obj, eng):
eng.ContinueNextToken()
There are NO explicit states, conditions, transitions - the job of the engine is
simply to run the tasks one after another. It is the responsibility of the task
to tell the engine what is going to happen next; whether to continue, stop,
jump back, jump forward and few other options.
There are NO explicit states, conditions, transitions - the job of the
engine is simply to run the tasks one after another. It is the
responsibility of the task to tell the engine what is going to happen
next; whether to continue, stop, jump back, jump forward and few other
options.

This is actually a *feature*, I knew that there will be a lot of possible
exceptions and transition states to implement for NLP processing and I also
Expand All @@ -78,10 +79,8 @@ you can make more errors and workflow engine will not warn you.
The workflow module comes with many patterns that can be directly used in the
definition of the pipeline, such as IF, IF_NOT, PARALLEL_SPLIT and others.

*This version requires Python 2 and many of the workflow patterns (such as IF,
XOR, WHILE) are implemented using lambdas, therefore not suitable for Python 3.*

The individual tasks then can influence the whole pipeline, available ''commands'' are:
The individual tasks then can influence the whole pipeline, available
''commands'' are:

.. code-block:: text
Expand Down Expand Up @@ -129,8 +128,8 @@ We can then write *workflow definition* like:
Tasks
-----

Tasks are simple python functions, we can enforce rules (not done yet!) in a pythonic
way using pydoc conventions, consider this:
Tasks are simple python functions, we can enforce rules (not done yet!) in
a pythonic way using pydoc conventions, consider this:

.. code-block:: python
Expand All @@ -150,14 +149,15 @@ way using pydoc conventions, consider this:
"""
...
So using the python docs, we can instruct workflow engine what types of arguments
are acceptable, what is the expected outcome and what happens after the task finished.
And let's say, there will be a testing framework which will run the workflow
pipeline with fake arguments and will test all sorts of conditions. So, the
configuration is not cluttered with states and transitions that are possible,
developers can focus on implementation of the individual tasks, and site admins
should have a good understanding what the task is supposed to do -- the description
of the task will be displayed through the web GUI.
So using the python docs, we can instruct workflow engine what types of
arguments are acceptable, what is the expected outcome and what happens
after the task finished. And let's say, there will be a testing framework
which will run the workflow pipeline with fake arguments and will test all
sorts of conditions. So, the configuration is not cluttered with states
and transitions that are possible, developers can focus on implementation
of the individual tasks, and site admins should have a good understanding
what the task is supposed to do -- the description of the task will be
displayed through the web GUI.

Some examples
-------------
Expand All @@ -171,8 +171,8 @@ patterns.

.. image:: http://www.yawlfoundation.org/images/patterns/basic_ps.jpg

This pattern is called Parallel split (as tasks B,C,D are all started in parallel
after task A). It could be implemented like this:
This pattern is called Parallel split (as tasks B,C,D are all started in
parallel after task A). It could be implemented like this:

.. code-block:: python
Expand Down
7 changes: 4 additions & 3 deletions setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -56,6 +56,10 @@ def run_tests(self):
classifiers=[
'Programming Language :: Python',
'Programming Language :: Python :: 2',
'Programming Language :: Python :: 2.6',
'Programming Language :: Python :: 2.7',
'Programming Language :: Python :: 3',
'Programming Language :: Python :: 3.3',
'Development Status :: 5 - Production/Stable',
'Environment :: Other Environment',
'Intended Audience :: Developers',
Expand Down Expand Up @@ -121,8 +125,5 @@ def next_token(obj, eng):
The workflow module comes with many patterns that can be directly used in the
definition of the pipeline, such as IF, IF_NOT, PARALLEL_SPLIT and others.
This version requires Python 2 and many of the workflow patterns (such as IF,
XOR, WHILE) are implemented using lambdas, therefore not suitable for Python 3.
"""
)

0 comments on commit b35b0df

Please sign in to comment.