aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/python
diff options
context:
space:
mode:
authorGravatar Nathaniel Manista <nathaniel@google.com>2015-02-18 22:47:25 +0000
committerGravatar Nathaniel Manista <nathaniel@google.com>2015-02-18 22:47:25 +0000
commit9b98bd89af3e715e98f7111b9a389ecc92dbb20c (patch)
tree3416bd9662dd3dd97de2633741bdf3c9b03eee00 /src/python
parent1ff680a545c0212008bb568f198c91b48a27df89 (diff)
Add a src/python/README.md.
Diffstat (limited to 'src/python')
-rwxr-xr-xsrc/python/README.md34
1 files changed, 34 insertions, 0 deletions
diff --git a/src/python/README.md b/src/python/README.md
new file mode 100755
index 0000000000..be2f2bedf9
--- /dev/null
+++ b/src/python/README.md
@@ -0,0 +1,34 @@
+GRPC Python
+=========
+
+The Python facility of GRPC.
+
+
+Prerequisites
+-----------------------
+
+Python 2.7, virtualenv, pip, libprotobuf-dev, and libprotoc-dev.
+
+
+Building from source
+----------------------
+
+- Build the GRPC core
+E.g, from the root of the grpc [git repo](https://github.com/google/grpc)
+```
+$ make shared_c static_c
+```
+
+- Use build_python.sh to build the Python code and install it into a virtual environment
+```
+$ tools/run_tests/build_python.sh
+```
+
+
+Testing
+-----------------------
+
+- Use run_python.sh to run GRPC as it was installed into the virtual environment
+```
+$ tools/run_tests/run_python.sh
+```