PostgreSQL database adapter for the Python programming language
Go to file
Daniele Varrazzo 76765aeb39 Print info about the binary package on build failed
The idea is to release a package 'psycopg2-binary' to allow installing
binary, and leave the psycopg2 package to be source only, to avoid
pushing the unreliability of the wheel pacakge by default (see issue #543).

Version number bumped to test with new packages.
2018-01-13 20:11:18 +00:00
doc 'key' docs in getconn() improved 2018-01-11 00:16:49 +00:00
examples cleanup remaining GPL license text 2014-05-20 09:50:53 -07:00
lib Merge branch 'python3_mintimeloggingconnection' into maint_2_7 2017-11-28 03:24:09 +00:00
psycopg Fixed idempotence check changing connection characteristics 2018-01-11 02:08:27 +00:00
sandbox cleanup remaining GPL license text 2014-05-20 09:42:41 -07:00
scripts Build and test packages with libpq 10.1 and OpenSSL 1.0.2m 2017-11-28 17:16:53 +00:00
tests Fixed idempotence check changing connection characteristics 2018-01-11 02:08:27 +00:00
.appveyor.yml Build and test packages with libpq 10.1 and OpenSSL 1.0.2m 2017-11-28 17:16:53 +00:00
.gitignore Added script to create manylinux1 wheels 2017-01-04 04:43:54 +01:00
.travis.yml Consider Python 3.6 and Postgres 9.6 supported 2017-01-03 19:12:44 +01:00
AUTHORS Preparing release 2.3.0-beta1 2010-11-06 15:50:39 +01:00
INSTALL Dropped content from the INSTALL file 2014-08-24 02:06:09 +01:00
LICENSE Changes license to LGPL3 + OpenSSL exception on all source files 2010-02-12 23:34:53 +01:00
Makefile Fixed 'make sdist' to work with setuptools 2016-03-10 12:10:51 +00:00
MANIFEST.in Fixed 'make sdist' to work with setuptools 2016-03-10 12:10:51 +00:00
NEWS Fixed idempotence check changing connection characteristics 2018-01-11 02:08:27 +00:00
psycopg2.cproj Move replication connection to C level. 2015-10-27 18:21:24 +01:00
psycopg2.sln New 'withhold' parameter for connection.cursor() 2011-08-10 18:25:46 +02:00
README.rst Link the appveyor badge in the readme to the master branch builds 2017-06-08 20:07:11 +01:00
setup.cfg Include license file in the generated wheel package 2017-11-26 10:42:30 -08:00
setup.py Print info about the binary package on build failed 2018-01-13 20:11:18 +00:00
tox.ini Python source cleanup using flake8 2016-10-11 00:11:55 +01: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/


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

If your ``pip`` version supports wheel_ packages it should be possible to
install a binary version of Psycopg including all the dependencies from PyPI_.
Just run::

    $ pip install -U pip      # make sure your pip is up-to-date
    $ pip install psycopg2

If you want to build Psycopg from source you will need some prerequisites (a C
compiler, development packages): please check the install_ and the faq_
documents in the ``doc`` dir for the details.

.. _wheel: http://pythonwheels.com/
.. _PyPI: https://pypi.python.org/pypi/psycopg2
.. _install: http://initd.org/psycopg/docs/install.html#install-from-source
.. _faq: http://initd.org/psycopg/docs/faq.html#faq-compile

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

.. __: 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