Minor fixes and update documentation. Preparing the upcoming 0.2 release.

bonobo/examples/types/__init__.py

@@ -0,0 +1,7 @@
+from . import bags, dicts, strings
+
+__all__ = [
+    'bags',
+    'dicts',
+    'strings',
+]

bonobo/examples/types/bags.py

@@ -0,0 +1,45 @@
+"""
+Example on how to use :class:`bonobo.Bag` instances to pass flexible args/kwargs to the next callable.
+
+.. graphviz::
+
+    digraph {
+        rankdir = LR;
+        stylesheet = "../_static/graphs.css";
+
+        BEGIN [shape="point"];
+        BEGIN -> "extract()" -> "transform(...)" -> "load(...)";
+    }
+
+"""
+
+
+from random import randint
+
+from bonobo import Bag, Graph
+
+
+def extract():
+    yield Bag(topic='foo')
+    yield Bag(topic='bar')
+    yield Bag(topic='baz')
+
+
+def transform(topic: str):
+    return Bag.inherit(
+        title=topic.title(),
+        rand=randint(10, 99)
+    )
+
+
+def load(topic: str, title: str, rand: int):
+    print('{} ({}) wait={}'.format(title, topic, rand))
+
+
+graph = Graph()
+graph.add_chain(extract, transform, load)
+
+if __name__ == '__main__':
+    from bonobo import run
+
+    run(graph)

bonobo/examples/types/dicts.py

@@ -0,0 +1,47 @@
+"""
+Example on how to use symple python dictionaries to communicate between transformations.
+
+.. graphviz::
+
+    digraph {
+        rankdir = LR;
+        stylesheet = "../_static/graphs.css";
+
+        BEGIN [shape="point"];
+        BEGIN -> "extract()" -> "transform(row: dict)" -> "load(row: dict)";
+    }
+
+"""
+
+from random import randint
+
+from bonobo import Graph
+
+
+def extract():
+    yield {'topic': 'foo'}
+    yield {'topic': 'bar'}
+    yield {'topic': 'baz'}
+
+
+def transform(row: dict):
+    return {
+        'topic': row['topic'].title(),
+        'randint': randint(10, 99),
+    }
+
+
+def load(row: dict):
+    print(row)
+
+
+graph = Graph(
+    extract,
+    transform,
+    load
+)
+
+if __name__ == '__main__':
+    from bonobo import run
+
+    run(graph)

bonobo/examples/types/strings.py

@@ -0,0 +1,43 @@
+"""
+Example on how to use symple python strings to communicate between transformations.
+
+.. graphviz::
+
+    digraph {
+        rankdir = LR;
+        stylesheet = "../_static/graphs.css";
+
+        BEGIN [shape="point"];
+        BEGIN -> "extract()" -> "transform(s: str)" -> "load(s: str)";
+    }
+
+"""
+from random import randint
+
+from bonobo import Graph
+
+
+def extract():
+    yield 'foo'
+    yield 'bar'
+    yield 'baz'
+
+
+def transform(s: str):
+    return '{} ({})'.format(s.title(), randint(10, 99))
+
+
+def load(s: str):
+    print(s)
+
+
+graph = Graph(
+    extract,
+    transform,
+    load
+)
+
+if __name__ == '__main__':
+    from bonobo import run
+
+    run(graph)