changeset 1:6aafed869664

notes to self
author Jeff Hammel <jhammel@mozilla.com>
date Sun, 07 Apr 2013 03:29:48 -0700
parents 67cfeffa0d90
children b8be785f8e87
files README.txt intentmademanifest/api.py
diffstat 2 files changed, 48 insertions(+), 3 deletions(-) [+]
line wrap: on
line diff
--- a/README.txt
+++ b/README.txt
@@ -1,11 +1,31 @@
 IntentMadeManifest
 ===========
 
 python workflow engine via directed graph
 
+As risen from the stillborn ashes:
+http://k0s.org/mozilla/hg/MozbaseWorkflow/
+
+Links
+-----
+
+Python packages:
+
+* https://pypi.python.org/pypi/finite
+  Yet another finite state automaton
+
+* https://pypi.python.org/pypi/fluidity-sm
+  State machine implementation for Python objects.
+
+* https://pypi.python.org/pypi/fysom
+  pYthOn Finite State Machine
+
+
+Potential Uses
+--------------
+
+* dependency somethin somethin'
+
 ----
 
 Jeff Hammel
-
-
-
new file mode 100644
--- /dev/null
+++ b/intentmademanifest/api.py
@@ -0,0 +1,25 @@
+"""
+API
+"""
+# TODO: probably to workflow.py, state.py, transition.py
+
+"""
+Example usage [STUB]:
+
+class MyWorkflow(Workflow):
+    def __init__(self, **kwargs):
+        Workflow.__init__(self, **kwargs)
+"""
+
+class Workflow(object):
+    """DG of all workflow"""
+
+    def __init__(self, initial_state=None):
+        """
+        - initial_state: if settable
+        """
+
+    def state(self):
+        """
+        current state
+        """