From 6b740df70427a7eebd443e280f2e1f0405773a00 Mon Sep 17 00:00:00 2001 From: Daniele Varrazzo Date: Sun, 14 Apr 2019 15:08:07 +0100 Subject: [PATCH] Added FAQ entry about the change in binary packages in 2.8 --- doc/src/faq.rst | 13 +++++++++++-- doc/src/install.rst | 25 +++++++++++++++---------- 2 files changed, 26 insertions(+), 12 deletions(-) diff --git a/doc/src/faq.rst b/doc/src/faq.rst index 24dca21e..2c6debd0 100644 --- a/doc/src/faq.rst +++ b/doc/src/faq.rst @@ -287,8 +287,17 @@ How do I interrupt a long-running query in an interactive shell? .. _faq-compile: -Problems compiling and deploying psycopg2 ------------------------------------------ +Problems compiling and installing psycopg2 +------------------------------------------ + +.. _faq-wheels: +.. cssclass:: faq + +Psycopg 2.8 fails to install, Psycopg 2.7 was working fine. + With Psycopg 2.7 you were installing binary packages, but they have proven + unreliable so now you have to install them explicitly using the + ``psycopg2-binary`` package. See :ref:`binary-packages` for all the + details. .. _faq-python-h: .. cssclass:: faq diff --git a/doc/src/install.rst b/doc/src/install.rst index 16377d74..98db5608 100644 --- a/doc/src/install.rst +++ b/doc/src/install.rst @@ -126,6 +126,8 @@ which is OS-dependent (for instance setting a suitable single: Install; wheel single: Wheel +.. _binary-packages: + Binary install from PyPI ------------------------ @@ -136,10 +138,12 @@ runtime prerequisites. .. note:: - The ``-binary`` package is meant for beginners to start playing with - Python and PostgreSQL without the need to meet the build requirements. + The ``psycopg2-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 + **you shouldn't use 'psycopg2-binary' as a module dependency**. For production use you are advised to use the source distribution. @@ -179,15 +183,16 @@ using something like ``pip install -U pip``), then you can run: .. _disable-wheel: -Disabling wheel packages for Psycopg 2.7 -^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ +Change in binary packages between Psycopg 2.7 and 2.8 +^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^^ -In version 2.7.x, `pip install psycopg2` would have tried to install the wheel -binary package of Psycopg. Because of the problems the wheel package have -displayed, `psycopg2-binary` has become a separate package, and from 2.8 it -has become the only way to install the binary package. +In version 2.7.x, :command:`pip install psycopg2` would have tried to install +automatically the binary package of Psycopg. Because of concurrency problems +binary packages have displayed, ``psycopg2-binary`` has become a separate +package, and from 2.8 it has become the only way to install the binary +package. -If you are using psycopg 2.7 and you want to disable the use of wheel binary +If you are using Psycopg 2.7 and you want to disable the use of wheel binary packages, relying on the system libraries available on your client, you can use the :command:`pip` |--no-binary option|__, e.g.: