README.md

gRPC Python

The Python facility of gRPC.

Status

Alpha : Ready for early adopters

PREREQUISITES

• Python 2.7, virtualenv, pip
• homebrew on Mac OS X. These simplify the installation of the gRPC C core.

INSTALLATION

Linux (Debian):

Add Debian unstable to your sources.list file. Example:

echo "deb http://ftp.us.debian.org/debian unstable main contrib non-free" | \
sudo tee -a /etc/apt/sources.list

Install the gRPC Debian package

sudo apt-get update
sudo apt-get install libgrpc-dev

Install the gRPC Python module

sudo pip install grpcio

Mac OS X

Install homebrew. Run the following command to install gRPC Python.

$ curl -fsSL https://goo.gl/getgrpc | bash -s python

This will download and run the gRPC install script, then install the latest version of the gRPC Python package. It also installs the Protocol Buffers compiler (protoc) and the gRPC protoc plugin for python.

EXAMPLES

Please read our online documentation for a Quick Start and a detailed example

BUILDING FROM SOURCE

• Clone this repository

• 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

PACKAGING

• Install packaging dependencies

$ pip install setuptools twine

• Push to PyPI

$ ../../tools/distrib/python/submit.py