diff options
author | Daniele Varrazzo <daniele.varrazzo@gmail.com> | 2018-05-23 21:42:43 +0100 |
---|---|---|
committer | Daniele Varrazzo <daniele.varrazzo@gmail.com> | 2018-05-23 21:42:43 +0100 |
commit | 6bcea5da3419ba7c11f88fc23be128c8ecf89d48 (patch) | |
tree | d13ac9791fcb649d388153af4b6cb80f519a27d7 | |
parent | 8195d83a8cc24171ccb1a6acb432f9776f1da6ff (diff) | |
download | psycopg2-6bcea5da3419ba7c11f88fc23be128c8ecf89d48.tar.gz |
Added note adivising against depending on the -wheels package
-rw-r--r-- | doc/src/install.rst | 17 |
1 files changed, 13 insertions, 4 deletions
diff --git a/doc/src/install.rst b/doc/src/install.rst index 98470de..30717c6 100644 --- a/doc/src/install.rst +++ b/doc/src/install.rst @@ -132,14 +132,23 @@ Binary install from PyPI `!psycopg2` is also `available on PyPI`__ in the form of wheel_ packages for the most common platform (Linux, OSX, Windows): this should make you able to install a binary version of the module, not requiring the above build or -runtime prerequisites, simply using: +runtime prerequisites. -.. code-block:: console +.. note:: + + The ``-binary`` package is meant for beginners to start playing with + Python and PostgreSQL without the need to meet the build requirements. + If you are the maintainer of a publish package depending on `!psycopg2` + you shouldn't use ``psycopg2-binary`` as a module dependency. For + production use you are advised to use the source distribution. - $ pip install psycopg2-binary Make sure to use an up-to-date version of :program:`pip` (you can upgrade it -using something like ``pip install -U pip``) +using something like ``pip install -U pip``), then you can run: + +.. code-block:: console + + $ pip install psycopg2-binary .. __: PyPI-binary_ .. _PyPI-binary: https://pypi.org/project/psycopg2-binary/ |