From: Daniele Varrazzo <daniele.varrazzo@gmail.com>
Date: Tue, 10 Oct 2023 21:21:57 +0000 (+0200)
Subject: docs: link together readme files on PyPI and add reference to psycopg2
X-Git-Tag: pool-3.1.9~5
X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=4c991e2b7ae70d753c15e43813b6abd15b8e7075;p=thirdparty%2Fpsycopg.git

docs: link together readme files on PyPI and add reference to psycopg2

See https://github.com/psycopg/psycopg2/issues/1632
---

diff --git a/psycopg/README.rst b/psycopg/README.rst
index 45eeac312..d6dfbe882 100644
--- a/psycopg/README.rst
+++ b/psycopg/README.rst
@@ -5,6 +5,17 @@ Psycopg 3 is a modern implementation of a PostgreSQL adapter for Python.
 
 This distribution contains the pure Python package ``psycopg``.
 
+.. Note::
+
+    Despite the lack of number in the package name, this package is the
+    successor of psycopg2_.
+
+    Please use the psycopg2 package if you are maintaining an existing program
+    using psycopg2 as a dependency. If you are developing something new,
+    Psycopg 3 is the most current implementation of the adapter.
+
+    .. _psycopg2: https://pypi.org/project/psycopg2/
+
 
 Installation
 ------------
diff --git a/psycopg_c/README-binary.rst b/psycopg_c/README-binary.rst
index 9318d5720..af435f422 100644
--- a/psycopg_c/README-binary.rst
+++ b/psycopg_c/README-binary.rst
@@ -1,8 +1,12 @@
 Psycopg 3: PostgreSQL database adapter for Python - binary package
 ==================================================================
 
-This distribution contains the precompiled optimization package
-``psycopg_binary``.
+This distribution package is an optional component of `Psycopg 3`__: it
+contains the optional optimization package `psycopg_binary`__.
+
+.. __: https://pypi.org/project/psycopg/
+.. __: https://www.psycopg.org/psycopg3/docs/basic/install.html
+       #binary-installation
 
 You shouldn't install this package directly: use instead ::
 
diff --git a/psycopg_c/README.rst b/psycopg_c/README.rst
index de9ba9326..bdfba0e7f 100644
--- a/psycopg_c/README.rst
+++ b/psycopg_c/README.rst
@@ -1,7 +1,12 @@
 Psycopg 3: PostgreSQL database adapter for Python - optimisation package
 ========================================================================
 
-This distribution contains the optional optimization package ``psycopg_c``.
+This distribution package is an optional component of `Psycopg 3`__: it
+contains the optional optimization package `psycopg_c`__.
+
+.. __: https://pypi.org/project/psycopg/
+.. __: https://www.psycopg.org/psycopg3/docs/basic/install.html
+       #local-installation
 
 You shouldn't install this package directly: use instead ::
 
diff --git a/psycopg_pool/README.rst b/psycopg_pool/README.rst
index 6e6b32cce..031173039 100644
--- a/psycopg_pool/README.rst
+++ b/psycopg_pool/README.rst
@@ -1,9 +1,10 @@
 Psycopg 3: PostgreSQL database adapter for Python - Connection Pool
 ===================================================================
 
-This distribution contains the optional connection pool package
-`psycopg_pool`__.
+This distribution package is an optional component of `Psycopg 3`__: it
+contains the optional connection pool package `psycopg_pool`__.
 
+.. __: https://pypi.org/project/psycopg/
 .. __: https://www.psycopg.org/psycopg3/docs/advanced/pool.html
 
 This package is kept separate from the main ``psycopg`` package because it is