Skip to content

Commit a97d262

Browse files
authored
docs: remove references to pipsi (#656)
Multiple people have experienced difficulty with pipsi. To that end, documentation recommending its use is now rewritten to recommend just using pyenv. Adds small comment expansion aroud bazel rules.
1 parent 9e63f97 commit a97d262

File tree

2 files changed

+19
-9
lines changed

2 files changed

+19
-9
lines changed

packages/gapic-generator/docs/getting-started/index.rst

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -7,15 +7,21 @@ protocol buffers do.
77

88
Because dependency management and such can be a significant undertaking, we
99
offer a Docker image and interface which requires you only to have Docker
10-
installed and provide the protos for your API.
10+
installed and provide the protos for your API. Alternatively, the generator is
11+
also invocable via bazel rules.
1112

1213
It is also possible to install the tool locally and run it through ``protoc``,
1314
and this approach is fully supported.
1415

1516
.. note::
1617

1718
The Docker approach is recommended for users new to this ecosystem, or
18-
those which do not have a robust Python environment available.
19+
those which do not have a robust Python environment available. If you want
20+
to experiment with generating client libraries but do not want to make
21+
changes to the generator itself, try the Docker image first.
22+
23+
The bazel approach is recommended for established pipelines. It is more
24+
lightweight than the Docker image but may take some more effort to set up.
1925

2026
.. _protocol buffers: https://developers.google.com/protocol-buffers/
2127

packages/gapic-generator/docs/getting-started/local.rst

Lines changed: 11 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -80,9 +80,6 @@ Python 3.7, so you will need that installed. (Most Linux distributions ship
8080
with earlier versions.) Use `pyenv`_ to get Python 3.7 installed in a
8181
friendly way.
8282

83-
As for this library itself, the recommended installation approach is
84-
`pipsi`_.
85-
8683
.. code-block:: shell
8784
8885
# Due to its experimental state, this tool is not published to a
@@ -91,11 +88,19 @@ As for this library itself, the recommended installation approach is
9188
git clone https://github.com/googleapis/gapic-generator-python.git
9289
cd gapic-generator-python/
9390
94-
# Install the tool. This will handle the virtualenv for you, and
91+
# Install a version of python that is supported by the microgenerator.
92+
# We use 3.8.6 as an example.
93+
# You may need to install additional packages in order to
94+
# build python from source.
95+
# Setting a 'global' python is convenient for development but may interfere
96+
# with other system activities. Adjust as your environment requires.
97+
pyenv install 3.8.6 && pyenv global 3.8.6
98+
99+
# Install the tool. This will handle the virtualenv for you, and
95100
# make an appropriately-aliased executable.
96101
# The `--editable` flag is only necessary if you want to work on the
97102
# tool (as opposed to just use it).
98-
pipsi install --editable --python=`which python3.7` .
103+
python -m pip install --editable .
99104
100105
To ensure the tool is installed properly:
101106

@@ -105,7 +110,6 @@ To ensure the tool is installed properly:
105110
/path/to/protoc-gen-python_gapic
106111
107112
.. _pyenv: https://github.com/pyenv/pyenv
108-
.. _pipsi: https://github.com/mitsuhiko/pipsi
109113

110114
Usage
111115
-----
@@ -151,7 +155,7 @@ This plugin is invoked under the hood via. the ``--python_gapic_out`` switch.
151155
the common protos must come first, and then the path to the API being built.
152156

153157
.. include:: _samplegen.rst
154-
158+
155159
.. code-block:: shell
156160
157161
# Multiple sample paths or directories can be passed simultaneously by duplicating

0 commit comments

Comments
 (0)