diff options
author | Masood Malekghassemi <atash@google.com> | 2016-04-27 14:59:17 -0700 |
---|---|---|
committer | Masood Malekghassemi <atash@google.com> | 2016-04-27 14:59:17 -0700 |
commit | d06e9291cb10c5757e1b7852248af341c2cd3390 (patch) | |
tree | 73554bb321b2b6cbd47b8bc36e23f80cb5ac9217 | |
parent | cec42984a0374465de9b2626f16b0efa960a66d0 (diff) |
Add Windows-specifics to Python docs
-rw-r--r-- | examples/python/README.md | 11 | ||||
-rw-r--r-- | src/python/grpcio/README.rst | 13 |
2 files changed, 22 insertions, 2 deletions
diff --git a/examples/python/README.md b/examples/python/README.md index b57da8f642..9992baa842 100644 --- a/examples/python/README.md +++ b/examples/python/README.md @@ -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 diff --git a/src/python/grpcio/README.rst b/src/python/grpcio/README.rst index 33a462b66f..cb3f6b87fe 100644 --- a/src/python/grpcio/README.rst +++ b/src/python/grpcio/README.rst @@ -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! @@ -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 ~~~~~~~~~~~~~~~ |