]> git.ipfire.org Git - thirdparty/psycopg.git/commitdiff
docs: add install differences grid
authorDaniele Varrazzo <daniele.varrazzo@gmail.com>
Wed, 29 Oct 2025 22:53:42 +0000 (22:53 +0000)
committerDaniele Varrazzo <daniele.varrazzo@gmail.com>
Wed, 29 Oct 2025 22:53:42 +0000 (22:53 +0000)
docs/basic/install.rst
pyproject.toml

index 131243ae5d22d27be624c9572650c1ba76aefef9..b21eb0a55fe6e8b61b41344a612b1aec94b52e16 100644 (file)
@@ -59,6 +59,47 @@ database may use the same wire protocol as PostgreSQL) but we cannot guarantee
 the correct working or a smooth ride.
 
 
+.. _install-grid:
+
+What to install?
+----------------
+
+There are a few different options to install Psycopg 3. This is a quick
+summary of their differences; follow the links for more details.
+
+.. list-table::
+   :header-rows: 1
+
+   * - Installation Option
+     - Command
+     - Description
+     - Perfor­mance
+     - Needs Local libpq?
+     - Needs Build Tools?
+
+   * - :ref:`binary-installation` (recommended for most users)
+     - ``pip install psycopg[binary]``
+     - Precompiled C extensions, packaged with client lbiraries.
+     - 🐇 Fast
+     - ❌ No
+     - ❌ No
+
+   * - :ref:`local-installation`
+     - ``pip install psycopg[c]``
+     - Builds C extensions from source.
+       Requires build tools and client libraries.
+     - 🐇 Fast
+     - ✅ Yes
+     - ✅ Yes
+
+   * - :ref:`pure-python-installation`
+     - ``pip install psycopg``
+     - Pure Python implementation only. Requires client libraries.
+     - 🐢 Slow
+     - ✅ Yes
+     - ❌ No
+
+
 .. _binary-installation:
 
 Binary installation
index 51b30efbe44879149eb24550325867d1d2840f15..9b7acfafca22ed9912c6933a7834dfbe43a26ed5 100644 (file)
@@ -60,7 +60,7 @@ disallow_untyped_defs = false
 disallow_untyped_calls = false
 
 [tool.codespell]
-ignore-words-list = "alot,ans,ba,fo,te,erro,varning"
+ignore-words-list = "alot,ans,ba,fo,te,erro,varning,perfor"
 skip = "build,_build,.tox,.mypy_cache,.venv,pq.c,_psycopg.c,*.html"
 
 [tool.isort]