From: Daniele Varrazzo Date: Thu, 30 Sep 2021 09:21:33 +0000 (+0200) Subject: Add supported systems in the docs X-Git-Tag: 3.0~46^2 X-Git-Url: http://git.ipfire.org/cgi-bin/gitweb.cgi?a=commitdiff_plain;h=5ad4b669dadcf629946e5fdc0c46134c9c1c5dab;p=thirdparty%2Fpsycopg.git Add supported systems in the docs --- diff --git a/docs/basic/install.rst b/docs/basic/install.rst index b8f2f7e97..699b1934d 100644 --- a/docs/basic/install.rst +++ b/docs/basic/install.rst @@ -3,12 +3,38 @@ Installation ============ -In short:: +In short, if you use a :ref:`supported system`:: pip install --upgrade pip # upgrade pip to at least 20.3 pip install --pre psycopg[binary] -and you should be :ref:`ready to start `. +and you should be :ref:`ready to start `. Read further for +alternative ways to install. + + +.. _supported-systems: + +Supported systems +----------------- + +The psycopg version documented here has *official and tested* support for: + +- Python: from version 3.6 to 3.9 +- PostgreSQL: from version 10 to 14 +- OS: Linux, macOS, Windows + +The tests to verify the supported systems run in `Github workflows`__: +anything that is not tested there is not officially supported. This includes: + +.. __: https://github.com/psycopg/psycopg/actions + +- Unofficial Python distributions such as Conda; +- Alternative PostgreSQL implementation; +- macOS hardware and releases not available on Github workflows. + +If you use an unsupported system things may work (because, for instance, the +database may use the same wire protocol as PostgreSQL) but we cannot guarantee +the correct working or a smooth ride. .. _binary-install: