From: Daniele Varrazzo Date: Wed, 29 Oct 2025 22:53:42 +0000 (+0000) Subject: docs: add install differences grid X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=04ab8bd45ea141cbc26de8c2a6f87e7a025b574c;p=thirdparty%2Fpsycopg.git docs: add install differences grid --- diff --git a/docs/basic/install.rst b/docs/basic/install.rst index 131243ae5..b21eb0a55 100644 --- a/docs/basic/install.rst +++ b/docs/basic/install.rst @@ -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 diff --git a/pyproject.toml b/pyproject.toml index 51b30efbe..9b7acfafc 100644 --- a/pyproject.toml +++ b/pyproject.toml @@ -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]