add a readme file for pyheron (#1944)

* add a readme file for pyheron * added the URL for streamparse
apache · Jun 8, 2017 · 41e6f38 · 41e6f38
1 parent babd3f9
commit 41e6f38
Show file tree

Hide file tree

Showing 2 changed files with 4 additions and 0 deletions.
diff --git a/scripts/packages/BUILD b/scripts/packages/BUILD
@@ -322,6 +322,7 @@ genrule(
     srcs = [
         "pyheron/requirements.txt", 
         "pyheron/setup.py.template",
+        "pyheron/README.txt",
     ] + generated_release_files,
     outs = generated_pyheron_egg_file,
     stamp = 1,

diff --git a/scripts/packages/pyheron/README.txt b/scripts/packages/pyheron/README.txt
@@ -0,0 +1,3 @@
+PyHeron is the python API for Heron, the distributed streaming engine.
+The API is based on the streamparse Storm python API from Parsely. More
+details can be found at https://github.com/Parsely/streamparse