Skip to content

Commit

Permalink
Merge pull request grpc#6321 from soltanmm/doc
Browse files Browse the repository at this point in the history
Add Windows-specifics to Python docs
  • Loading branch information
jtattermusch committed Apr 28, 2016
2 parents 7fb941e + d06e929 commit 2ea6765
Show file tree
Hide file tree
Showing 2 changed files with 22 additions and 2 deletions.
11 changes: 9 additions & 2 deletions examples/python/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,12 +8,19 @@ For this sample, we've already generated the server and client stubs from


Install gRPC:
```sh
```sh
$ pip install grpcio
```
Or, to install it system wide:
```sh
$ sudo pip install grpcio
$ sudo pip install grpcio
```

If you're on Windows, make sure you installed the `pip.exe` component when you
installed Python. Invoke as above but with `pip.exe` instead of `pip` (you may
also need to invoke from a `cmd.exe` ran as administrator):
```sh
$ pip.exe install grpcio
```

Download the example
Expand Down
13 changes: 13 additions & 0 deletions src/python/grpcio/README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -23,6 +23,16 @@ Else system wide (on Ubuntu)...

$ sudo pip install grpcio

If you're on Windows make sure that you installed the :code:`pip.exe` component
when you installed Python (if not go back and install it!) then invoke:

::

$ pip.exe install grpcio

Windows users may need to invoke :code:`pip.exe` from a command line ran as
administrator.

n.b. On Windows and on Mac OS X one *must* have a recent release of :code:`pip`
to retrieve the proper wheel from PyPI. Be sure to upgrade to the latest
version!
Expand All @@ -43,6 +53,9 @@ package named :code:`python-dev`).
$ pip install -rrequirements.txt
$ GRPC_PYTHON_BUILD_WITH_CYTHON=1 pip install .

You cannot currently install Python from source on Windows. Things might work
out for you in MSYS2 (follow the Linux instructions), but it isn't officially
supported at the moment.

Troubleshooting
~~~~~~~~~~~~~~~
Expand Down

0 comments on commit 2ea6765

Please sign in to comment.