aboutsummaryrefslogtreecommitdiffhomepage
path: root/src/python/grpcio/README.rst
diff options
context:
space:
mode:
authorGravatar Masood Malekghassemi <atash@google.com>2016-02-12 14:48:00 -0800
committerGravatar Masood Malekghassemi <atash@google.com>2016-02-12 15:20:34 -0800
commitdfab11919e1d5386ba505add129e9395d56ae93d (patch)
treebac875707cc7f73a9d971e05ce2a4853e88be476 /src/python/grpcio/README.rst
parentae33720bd9709aef4ee700692164f64e2f532fa9 (diff)
Update Python doc
Diffstat (limited to 'src/python/grpcio/README.rst')
-rw-r--r--src/python/grpcio/README.rst38
1 files changed, 28 insertions, 10 deletions
diff --git a/src/python/grpcio/README.rst b/src/python/grpcio/README.rst
index c7b5a3bde4..698c760ebe 100644
--- a/src/python/grpcio/README.rst
+++ b/src/python/grpcio/README.rst
@@ -1,22 +1,40 @@
gRPC Python
===========
-Package for GRPC Python.
+Package for gRPC Python.
-Dependencies
+Installation
------------
-Ensure you have installed the gRPC core. On Mac OS X, install homebrew_.
-Run the following command to install gRPC Python.
+gRPC Python is available for Linux and Mac OS X running Python 2.7.
+
+From PyPI
+~~~~~~~~~
+
+If you are installing locally...
::
- $ curl -fsSL https://goo.gl/getgrpc | bash -s python
+ $ pip install grpcio
+
+Else system wide (on Ubuntu)...
+
+::
-This will download and run the [gRPC install script][] to install grpc core. The script then uses pip to install this package. It also installs the Protocol Buffers compiler (_protoc_) and the gRPC _protoc_ plugin for python.
+ $ sudo pip install grpcio
+
+From Source
+~~~~~~~~~~~
+
+Building from source requires that you have the Python headers (usually a
+package named `python-dev`).
+
+::
-Otherwise, `install from source`_
+ $ export REPO_ROOT=grpc
+ $ git clone https://github.com/grpc/grpc.git $REPO_ROOT
+ $ cd $REPO_ROOT
+ $ pip install .
-.. _`install from source`: https://github.com/grpc/grpc/blob/master/src/python/README.md#building-from-source
-.. _homebrew: http://brew.sh
-.. _`gRPC install script`: https://raw.githubusercontent.com/grpc/homebrew-grpc/master/scripts/install
+Note that `$REPO_ROOT` can be assigned to whatever directory name floats your
+fancy.