]> git.ipfire.org Git - thirdparty/psycopg.git/commitdiff
docs: link together readme files on PyPI and add reference to psycopg2
authorDaniele Varrazzo <daniele.varrazzo@gmail.com>
Tue, 10 Oct 2023 21:21:57 +0000 (23:21 +0200)
committerDaniele Varrazzo <daniele.varrazzo@gmail.com>
Tue, 10 Oct 2023 21:22:59 +0000 (23:22 +0200)
See https://github.com/psycopg/psycopg2/issues/1632

psycopg/README.rst
psycopg_c/README-binary.rst
psycopg_c/README.rst
psycopg_pool/README.rst

index 45eeac312f5e40616c32533289395b06356d48dc..d6dfbe882ddc318a317a66c6a9d5f8bc0b7e1507 100644 (file)
@@ -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
 ------------
index 9318d572068ab5f60d54065aab46d453d9391f31..af435f4222ca30b8ee38f78eedb24aaf319585c5 100644 (file)
@@ -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 ::
 
index de9ba9326282dd4c157df1d1b492f7486dbbd00f..bdfba0e7f9c8bc1ab02e1a7e909939abba791002 100644 (file)
@@ -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 ::
 
index 6e6b32cce83848aae49e924a1cb4904ed05d4c05..031173039ec70b52803684275246ba71710c8cc8 100644 (file)
@@ -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