From a651c5fb763c69a921aecdd3e1d8dc51dbf20f8d Mon Sep 17 00:00:00 2001 From: Bu Sun Kim <8822365+busunkim96@users.noreply.github.com> Date: Tue, 22 Sep 2020 12:06:12 -0600 Subject: [PATCH] chore(python): remove note about editable installs (#769) `pip install -e .` is supported and is how we install the library for tests. --- .../templates/python_library/CONTRIBUTING.rst | 19 ------------------- 1 file changed, 19 deletions(-) diff --git a/synthtool/gcp/templates/python_library/CONTRIBUTING.rst b/synthtool/gcp/templates/python_library/CONTRIBUTING.rst index 7a1f87440..2e6e57db1 100644 --- a/synthtool/gcp/templates/python_library/CONTRIBUTING.rst +++ b/synthtool/gcp/templates/python_library/CONTRIBUTING.rst @@ -80,25 +80,6 @@ We use `nox `__ to instrument our tests. .. nox: https://pypi.org/project/nox/ -Note on Editable Installs / Develop Mode -======================================== - -- As mentioned previously, using ``setuptools`` in `develop mode`_ - or a ``pip`` `editable install`_ is not possible with this - library. This is because this library uses `namespace packages`_. - For context see `Issue #2316`_ and the relevant `PyPA issue`_. - - Since ``editable`` / ``develop`` mode can't be used, packages - need to be installed directly. Hence your changes to the source - tree don't get incorporated into the **already installed** - package. - -.. _namespace packages: https://www.python.org/dev/peps/pep-0420/ -.. _Issue #2316: https://github.com/GoogleCloudPlatform/google-cloud-python/issues/2316 -.. _PyPA issue: https://github.com/pypa/packaging-problems/issues/12 -.. _develop mode: https://setuptools.readthedocs.io/en/latest/setuptools.html#development-mode -.. _editable install: https://pip.pypa.io/en/stable/reference/pip_install/#editable-installs - ***************************************** I'm getting weird errors... Can you help? *****************************************