PostgreSQL database adapter for the Python programming language
Go to file
Daniele Varrazzo 38a411dc07 Test Python 3.4 on xenial
Trusty is no more required, and PG 12 is not available there.
2019-10-19 15:50:57 +02:00
doc Test PG 11 and 12 on travis 2019-10-19 15:26:20 +02:00
lib Added Postgres 12 errors 2019-10-19 15:22:48 +02:00
psycopg Added Postgres 12 errors 2019-10-19 15:22:48 +02:00
scripts Test PG 11 and 12 on travis 2019-10-19 15:26:20 +02:00
tests Use travis test config variable 0/1 instead of blank strings 2019-10-19 15:18:38 +02:00
.appveyor.yml Dropped command line config from appveyor scrips 2019-04-22 12:41:44 +01:00
.gitignore Added table of sqlstate exceptions in the docs 2019-02-17 01:55:14 +01:00
.travis.yml Test Python 3.4 on xenial 2019-10-19 15:50:57 +02:00
AUTHORS Trim trailing whitespace from all files throughout project 2017-12-01 21:42:14 -08:00
INSTALL Dropped content from the INSTALL file 2014-08-24 02:06:09 +01:00
LICENSE Prefer https:// URLs when available 2018-09-22 19:02:33 -07:00
Makefile Dropped text docs generation 2019-02-17 00:58:27 +00:00
MANIFEST.in Dropped examples dir (and some leftover reference to the sandbox dir) 2018-11-16 17:06:06 +00:00
NEWS Added Postgres 12 errors 2019-10-19 15:22:48 +02:00
psycopg2.cproj Dropped text docs generation 2019-02-17 00:58:27 +00:00
README.rst Update all pypi.python.org URLs to pypi.org 2018-05-20 17:22:37 +01:00
setup.cfg Removed support for mxDateTime as the default date and time adapter 2019-03-16 16:36:49 +00:00
setup.py Bump to next dev version number 2019-06-21 11:26:29 +01:00
tox.ini Dropped examples dir (and some leftover reference to the sandbox dir) 2018-11-16 17:06:06 +00:00

psycopg2 - Python-PostgreSQL Database Adapter
=============================================

Psycopg is the most popular PostgreSQL database adapter for the Python
programming language.  Its main features are the complete implementation of
the Python DB API 2.0 specification and the thread safety (several threads can
share the same connection).  It was designed for heavily multi-threaded
applications that create and destroy lots of cursors and make a large number
of concurrent "INSERT"s or "UPDATE"s.

Psycopg 2 is mostly implemented in C as a libpq wrapper, resulting in being
both efficient and secure.  It features client-side and server-side cursors,
asynchronous communication and notifications, "COPY TO/COPY FROM" support.
Many Python types are supported out-of-the-box and adapted to matching
PostgreSQL data types; adaptation can be extended and customized thanks to a
flexible objects adaptation system.

Psycopg 2 is both Unicode and Python 3 friendly.


Documentation
-------------

Documentation is included in the ``doc`` directory and is `available online`__.

.. __: http://initd.org/psycopg/docs/

For any other resource (source code repository, bug tracker, mailing list)
please check the `project homepage`__.


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

Building Psycopg requires a few prerequisites (a C compiler, some development
packages): please check the install_ and the faq_ documents in the ``doc`` dir
or online for the details.

If prerequisites are met, you can install psycopg like any other Python
package, using ``pip`` to download it from PyPI_::

    $ pip install psycopg2

or using ``setup.py`` if you have downloaded the source package locally::

    $ python setup.py build
    $ sudo python setup.py install

You can also obtain a stand-alone package, not requiring a compiler or
external libraries, by installing the `psycopg2-binary`_ package from PyPI::

    $ pip install psycopg2-binary

The binary package is a practical choice for development and testing but in
production it is advised to use the package built from sources.

.. _PyPI: https://pypi.org/project/psycopg2/
.. _psycopg2-binary: https://pypi.org/project/psycopg2-binary/
.. _install: http://initd.org/psycopg/docs/install.html#install-from-source
.. _faq: http://initd.org/psycopg/docs/faq.html#faq-compile

.. __: http://initd.org/psycopg/


:Linux/OSX: |travis|
:Windows: |appveyor|

.. |travis| image:: https://travis-ci.org/psycopg/psycopg2.svg?branch=master
    :target: https://travis-ci.org/psycopg/psycopg2
    :alt: Linux and OSX build status

.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/psycopg/psycopg2?branch=master&svg=true
    :target: https://ci.appveyor.com/project/psycopg/psycopg2/branch/master
    :alt: Windows build status