From b032dca0b202f290aee66ac9da5dccea771ba80f Mon Sep 17 00:00:00 2001 From: Daniele Varrazzo Date: Sat, 6 Aug 2022 01:47:54 +0200 Subject: [PATCH] docs: quote examples of pip install with extras zsh doesn't parse the square brackets as expected. See #347. --- README.rst | 4 ++-- docs/Makefile | 2 +- docs/advanced/pool.rst | 2 +- docs/api/pool.rst | 2 +- docs/api/pq.rst | 4 ++-- docs/basic/install.rst | 8 ++++---- psycopg/README.rst | 2 +- psycopg_c/README-binary.rst | 2 +- psycopg_c/README.rst | 2 +- psycopg_pool/README.rst | 2 +- tests/README.rst | 4 ++-- 11 files changed, 17 insertions(+), 17 deletions(-) diff --git a/README.rst b/README.rst index d9ab197db..f71a53d2b 100644 --- a/README.rst +++ b/README.rst @@ -10,7 +10,7 @@ Installation Quick version:: pip install --upgrade pip # upgrade pip to at least 20.3 - pip install psycopg[binary,pool] # install binary dependencies + pip install "psycopg[binary,pool]" # install binary dependencies For further information about installation please check `the documentation`__. @@ -57,7 +57,7 @@ requirements:: python -m venv .venv source .venv/bin/activate - pip install -e ./psycopg[dev,test] # for the base Python package + pip install -e "./psycopg[dev,test]" # for the base Python package pip install -e ./psycopg_c # for the C extension module pip install -e ./psycopg_pool # for the connection pool diff --git a/docs/Makefile b/docs/Makefile index 8df6ecc5c..e86cbd48d 100644 --- a/docs/Makefile +++ b/docs/Makefile @@ -22,7 +22,7 @@ env: .venv .venv: $(PYTHON) -m venv .venv - ./.venv/bin/pip install -e ../psycopg[docs] -e ../psycopg_pool + ./.venv/bin/pip install -e "../psycopg[docs]" -e ../psycopg_pool # Catch-all target: route all unknown targets to Sphinx using the new # "make mode" option. $(O) is meant as a shortcut for $(SPHINXOPTS). diff --git a/docs/advanced/pool.rst b/docs/advanced/pool.rst index f88345f31..35d78110b 100644 --- a/docs/advanced/pool.rst +++ b/docs/advanced/pool.rst @@ -16,7 +16,7 @@ behaviour. Please refer to the `ConnectionPool` object API for details about the pool operations. .. note:: The connection pool objects are distributed in a package separate - from the main `psycopg` package: use ``pip install psycopg[pool]`` or ``pip + from the main `psycopg` package: use ``pip install "psycopg[pool]"`` or ``pip install psycopg_pool`` to make the `psycopg_pool` package available. See :ref:`pool-installation`. diff --git a/docs/api/pool.rst b/docs/api/pool.rst index 092ff6a51..5104fcf91 100644 --- a/docs/api/pool.rst +++ b/docs/api/pool.rst @@ -30,7 +30,7 @@ This package exposes a few connection pool classes: `!AsyncConnectionPool`. .. note:: The `!psycopg_pool` package is distributed separately from the main - `psycopg` package: use ``pip install psycopg[pool]``, or ``pip install + `psycopg` package: use ``pip install "psycopg[pool]"``, or ``pip install psycopg_pool``, to make it available. See :ref:`pool-installation`. The version numbers indicated in this page refer to the `!psycopg_pool` diff --git a/docs/api/pq.rst b/docs/api/pq.rst index 2acc156bf..3c135171f 100644 --- a/docs/api/pq.rst +++ b/docs/api/pq.rst @@ -34,13 +34,13 @@ same interface. Current implementations are: in Cython_). It is much better performing than the ``python`` implementation, however it requires development packages installed on the client machine. It can be installed using the ``c`` extra, i.e. running - ``pip install psycopg[c]``. + ``pip install "psycopg[c]"``. - ``binary``: a pre-compiled C implementation, bundled with all the required libraries. It is the easiest option to deal with, fast to install and it should require no development tool or client library, however it may be not available for every platform. You can install it using the ``binary`` extra, - i.e. running ``pip install psycopg[binary]``. + i.e. running ``pip install "psycopg[binary]"``. .. _Cython: https://cython.org/ diff --git a/docs/basic/install.rst b/docs/basic/install.rst index c7f395c70..a20c6a714 100644 --- a/docs/basic/install.rst +++ b/docs/basic/install.rst @@ -6,7 +6,7 @@ Installation In short, if you use a :ref:`supported system`:: pip install --upgrade pip # upgrade pip to at least 20.3 - pip install psycopg[binary] + pip install "psycopg[binary]" and you should be :ref:`ready to start `. Read further for alternative ways to install. @@ -48,7 +48,7 @@ Binary installation The quickest way to start developing with Psycopg 3 is to install the binary packages by running:: - pip install psycopg[binary] + pip install "psycopg[binary]" This will install a self-contained package with all the libraries needed. **You will need pip 20.3 at least**: please run ``pip install --upgrade pip`` @@ -101,7 +101,7 @@ try this and follow the `binary installation`_ instead. If your build prerequisites are in place you can run:: - pip install psycopg[c] + pip install "psycopg[c]" .. _pure-python-installation: @@ -145,7 +145,7 @@ separate package from the `!psycopg` package itself, in order to allow a different release cycle. In order to use the pool you must install the ``pool`` extra, using ``pip -install psycopg[pool]``, or install the `psycopg_pool` package separately, +install "psycopg[pool]"``, or install the `psycopg_pool` package separately, which would allow to specify the release to install more precisely. diff --git a/psycopg/README.rst b/psycopg/README.rst index 2bbb04299..45eeac312 100644 --- a/psycopg/README.rst +++ b/psycopg/README.rst @@ -12,7 +12,7 @@ Installation In short, run the following:: pip install --upgrade pip # to upgrade pip - pip install psycopg[binary,pool] # to install package and dependencies + pip install "psycopg[binary,pool]" # to install package and dependencies If something goes wrong, and for more information about installation, please check out the `Installation documentation`__. diff --git a/psycopg_c/README-binary.rst b/psycopg_c/README-binary.rst index 275082c52..9318d5720 100644 --- a/psycopg_c/README-binary.rst +++ b/psycopg_c/README-binary.rst @@ -6,7 +6,7 @@ This distribution contains the precompiled optimization package You shouldn't install this package directly: use instead :: - pip install psycopg[binary] + pip install "psycopg[binary]" to install a version of the optimization package matching the ``psycopg`` version installed. diff --git a/psycopg_c/README.rst b/psycopg_c/README.rst index 2f24ee5e6..de9ba9326 100644 --- a/psycopg_c/README.rst +++ b/psycopg_c/README.rst @@ -5,7 +5,7 @@ This distribution contains the optional optimization package ``psycopg_c``. You shouldn't install this package directly: use instead :: - pip install psycopg[c] + pip install "psycopg[c]" to install a version of the optimization package matching the ``psycopg`` version installed. diff --git a/psycopg_pool/README.rst b/psycopg_pool/README.rst index 27b05069b..6e6b32cce 100644 --- a/psycopg_pool/README.rst +++ b/psycopg_pool/README.rst @@ -11,7 +11,7 @@ likely that it will follow a different release cycle. You can also install this package using:: - pip install psycopg[pool] + pip install "psycopg[pool]" Please read `the project readme`__ and `the installation documentation`__ for more details. diff --git a/tests/README.rst b/tests/README.rst index 7440b72a4..2e0511c1c 100644 --- a/tests/README.rst +++ b/tests/README.rst @@ -8,7 +8,7 @@ To run tests on the current code you can install the `test` extra of the package, specify a connection string in the `PSYCOPG_TEST_DSN` env var to connect to a test database, and run ``pytest``:: - $ pip install -e psycopg[test] + $ pip install -e "psycopg[test]" $ export PSYCOPG_TEST_DSN="host=localhost dbname=psycopg_test" $ pytest @@ -69,7 +69,7 @@ a set of env vars working for your setup:: -e PSYCOPG_TEST_DSN -e PGHOST=172.17.0.1 -e PGUSER=`whoami` \ python:3.7 bash - # pip install -e ./psycopg[test] ./psycopg_pool ./psycopg_c + # pip install -e "./psycopg[test]" ./psycopg_pool ./psycopg_c # pytest -- 2.47.2