]> git.ipfire.org Git - thirdparty/psycopg.git/commitdiff
docs: quote examples of pip install with extras
authorDaniele Varrazzo <daniele.varrazzo@gmail.com>
Fri, 5 Aug 2022 23:47:54 +0000 (01:47 +0200)
committerDaniele Varrazzo <daniele.varrazzo@gmail.com>
Fri, 5 Aug 2022 23:59:18 +0000 (01:59 +0200)
zsh doesn't parse the square brackets as expected.

See #347.

README.rst
docs/Makefile
docs/advanced/pool.rst
docs/api/pool.rst
docs/api/pq.rst
docs/basic/install.rst
psycopg/README.rst
psycopg_c/README-binary.rst
psycopg_c/README.rst
psycopg_pool/README.rst
tests/README.rst

index d9ab197db1754b24ed1d29222d5f14adfae2d86b..f71a53d2b154c15fdcaa910c3abaee653cd754a9 100644 (file)
@@ -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
 
index 8df6ecc5c222747e9dda6c53c20a2fc415905583..e86cbd48d52f0ef3e30ad5b736c7daa8865f5455 100644 (file)
@@ -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).
index f88345f3160c3fe8a0260c13148fbd5abc3727e3..35d78110b6147eb2ec404b12de19824162e099ab 100644 (file)
@@ -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`.
 
index 092ff6a5185306a39b6e21e870a1f9aa0513e4b2..5104fcf919cef3c49175cb8a6402cfe892a0a955 100644 (file)
@@ -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`
index 2acc156bf1e260d008950ddf466bb00510bcd4c5..3c135171f693c748619dbc82976536356d7b2f24 100644 (file)
@@ -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/
 
index c7f395c7038d840e5a259aaf6c319a241e68e165..a20c6a71480a3040cda978a62be2cdf7ddfe1772 100644 (file)
@@ -6,7 +6,7 @@ Installation
 In short, if you use a :ref:`supported system<supported-systems>`::
 
     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 <module-usage>`. 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.
 
 
index 2bbb04299f372deccde665c8dd9c74d3044cd78e..45eeac312f5e40616c32533289395b06356d48dc 100644 (file)
@@ -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`__.
index 275082c5236f1bd62908fc4150b21274ddbec3be..9318d572068ab5f60d54065aab46d453d9391f31 100644 (file)
@@ -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.
index 2f24ee5e688afc99333096e7899ead06806b4955..de9ba9326282dd4c157df1d1b492f7486dbbd00f 100644 (file)
@@ -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.
index 27b05069b51e83ec1225c7d5878bd3a72ddd6ee7..6e6b32cce83848aae49e924a1cb4904ed05d4c05 100644 (file)
@@ -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.
index 7440b72a4c391ddc0d71bd5f487ebd182dbcb57d..2e0511c1c42f8e3ac0d7eff55892c84950862e82 100644 (file)
@@ -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