Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/psycopg/psycopg
New generation PostgreSQL database adapter for the Python programming language
https://github.com/psycopg/psycopg
database development driver postgresql python
Last synced: about 1 month ago
JSON representation
New generation PostgreSQL database adapter for the Python programming language
- Host: GitHub
- URL: https://github.com/psycopg/psycopg
- Owner: psycopg
- License: lgpl-3.0
- Created: 2020-03-15T04:15:53.000Z (over 4 years ago)
- Default Branch: master
- Last Pushed: 2024-05-27T14:22:01.000Z (3 months ago)
- Last Synced: 2024-05-27T15:24:41.328Z (3 months ago)
- Topics: database, development, driver, postgresql, python
- Language: Python
- Homepage: https://www.psycopg.org/psycopg3/
- Size: 5.53 MB
- Stars: 1,519
- Watchers: 27
- Forks: 147
- Open Issues: 35
-
Metadata Files:
- Readme: README.rst
- Funding: .github/FUNDING.yml
- License: LICENSE.txt
Awesome Lists containing this project
- best-of-python - GitHub - 7% open · ⏱️ 04.06.2024): (Database Clients)
README
Psycopg 3 -- PostgreSQL database adapter for Python
===================================================Psycopg 3 is a modern implementation of a PostgreSQL adapter for Python.
Installation
------------Quick version::
pip install --upgrade pip # upgrade pip to at least 20.3
pip install "psycopg[binary,pool]" # install binary dependenciesFor further information about installation please check `the documentation`__.
.. __: https://www.psycopg.org/psycopg3/docs/basic/install.html
Hacking
-------In order to work on the Psycopg source code you need to have the ``libpq``
PostgreSQL client library installed in the system. For instance, on Debian
systems, you can obtain it by running::sudo apt install libpq5
After which you can clone this repository::
git clone https://github.com/psycopg/psycopg.git
cd psycopgPlease note that the repository contains the source code of several Python
packages: that's why you don't see a ``setup.py`` here. The packages may have
different requirements:- The ``psycopg`` directory contains the pure python implementation of
``psycopg``. The package has only a runtime dependency on the ``libpq``, the
PostgreSQL client library, which should be installed in your system.- The ``psycopg_c`` directory contains an optimization module written in
C/Cython. In order to build it you will need a few development tools: please
look at `Local installation`__ in the docs for the details.- The ``psycopg_pool`` directory contains the `connection pools`__
implementations. This is kept as a separate package to allow a different
release cycle... __: https://www.psycopg.org/psycopg3/docs/basic/install.html#local-installation
.. __: https://www.psycopg.org/psycopg3/docs/advanced/pool.htmlYou can create a local virtualenv and install the packages `in
development mode`__, together with their development and testing
requirements::python -m venv .venv
source .venv/bin/activate
pip install -e "./psycopg[dev,test]" # for the base Python package
pip install -e ./psycopg_pool # for the connection pool
pip install ./psycopg_c # for the C speedup module.. __: https://pip.pypa.io/en/stable/topics/local-project-installs/#editable-installs
Please add ``--config-settings editable_mode=strict`` to the ``pip install
-e`` above if you experience `editable mode broken`__... __: https://github.com/pypa/setuptools/issues/3557
Now hack away! You can run the tests using::
psql -c 'create database psycopg_test'
export PSYCOPG_TEST_DSN="dbname=psycopg_test"
pytest