PostgreSQL database adapter for the Python programming language
Go to file
Jon Dufresne a739c09f67 Simplify 'decorate_all_tests' usage by decorating the test class
Skip tests as early as possible by decorating the whole class with
unittest.skipIf instead of every test method individually.
2018-12-01 19:40:27 -08:00
doc Merge branch 'master' into feature-expose-pgconn 2018-11-07 14:15:29 +01:00
lib Don't barf on Composite passed to execute_values() 2018-10-23 01:57:48 +01:00
psycopg Convert int subclasses to long before adapting 2018-11-16 18:16:03 +00:00
scripts Dropped duplicate classes in errors module 2018-10-23 00:31:57 +01:00
tests Simplify 'decorate_all_tests' usage by decorating the test class 2018-12-01 19:40:27 -08:00
.appveyor.yml Prefer https:// URLs when available 2018-09-22 19:02:33 -07:00
.gitignore Allow SPHINXBUILD on command line 2018-10-07 13:55:11 +02:00
.travis.yml Add testing and document support for Python 3.7 2018-07-12 18:07:25 -07: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 PYTHONPATH propagation in 'make check' 2017-12-11 02:22:02 +00:00
MANIFEST.in Dropped examples dir (and some leftover reference to the sandbox dir) 2018-11-16 17:06:06 +00:00
NEWS Convert int subclasses to long before adapting 2018-11-16 18:16:03 +00:00
psycopg2.cproj Dropped examples dir (and some leftover reference to the sandbox dir) 2018-11-16 17:06:06 +00:00
README.rst Update all pypi.python.org URLs to pypi.org 2018-05-20 17:22:37 +01:00
setup.cfg Include license file in the generated wheel package 2017-11-26 10:42:30 -08:00
setup.py Moving host attribute to a connection.info object 2018-10-11 22:42:52 +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