The Psycopg Team ORG

Psycopg 3 -- PostgreSQL database adapter for Python
===================================================

Psycopg 3 is a modern implementation of a PostgreSQL adapter for Python.

Installation
------------

Quick version::

pip install "psycopg[binary,pool]"

For further information about installation please check the documentation__.

.. __: https://www.psycopg.org/psycopg3/docs/basic/install.html

.. _Hacking:

Hacking
-------

In order to work on the Psycopg source code, you must have the
`libpq PostgreSQL client library installed on the system. For instance, on
Debian systems, you can obtain it by running::

On Windows you can use EnterpriseDB's installers__ to obtain libpq
which is included in the Command Line Tools.

• The psycopg directory contains the pure python implementation of

• The psycopg_c directory contains an optimization module written in

• The psycopg_pool directory contains the connection pools__

You can create a local virtualenv and install the packages in
development mode__, together with their development and testing
requirements::

The --config-settings editable_mode=strict will be probably required
to work around the problem of the editable mode broken__.

If some of the tests fail on your local host, it may be helpful to exclude the
proxy, subprocess, and/or timing tests to get a clean test run, for
example::

The project includes some pre-commit__ hooks to check that the code is valid
according to the project coding convention. Please make sure to install them
by running::

Please follow the conventional commits__ specification for your commit messages.

To use cross-platform zipapps created with shiv__ that include Psycopg
as a dependency you must also have libpq installed. See
the section above `_ for install instructions.

.. __: https://github.com/linkedin/shiv

Collapse