Commits

Lars Yencken committed fd152fb

Improve the README.

  • Participants
  • Parent commits 39f488b

Comments (0)

Files changed (1)

 Installing
 ==========
 
-Run ``pip install drakeutil``, then for Python steps inside your workflow include::
+Run ``pip install drakeutil``.
+
+Using
+=====
+
+For Python steps inside your workflow include the line::
+
+    from drakeutil import *
+
+This will populate the special family of variables ``INPUT``, ``OUTPUT`` from the environment. For example::
 
     somefile.out <- somefile.in [python]
         from drakeutil import *
+        with open(INPUT) as istream:
+            with open(OUTPUT) as ostream:
+                for l in istream:
+                    for word in l.split():
+                        print >> ostream, word
+
+In the future we might add more helpers. Can you think of any that would be useful?
+
+Changelog
+=========
+
+0.1.0
+-----
+
+- Support special ``INPUT`` and ``OUTPUT`` environment variables
+- Provide ``mysql_cursor`` helper when ``MySQLdb`` module is installed
 
 .. _Drake: https://github.com/Factual/drake