PostgreSQL database adapter for the Python programming language
Go to file
Jon Dufresne 389f6c08d9 Avoid installing tests to site-packages
For library end users, there is no need to install tests alongside the
package itself. This keeps the tests available for development without
adding extra packages to user's site-packages directory. Reduces the
size of the installed package. Avoids accidental execution of test code
by an installed package.
2017-12-10 10:55:58 -08:00
doc Avoid installing tests to site-packages 2017-12-10 10:55:58 -08:00
examples Use print() function instead of print statement throughout project 2017-12-10 10:51:07 -08:00
lib Drop long deprecated function register_tstz_w_secs() 2017-12-10 07:57:11 -08:00
psycopg Trim trailing whitespace from all files throughout project 2017-12-01 21:42:14 -08:00
sandbox Use print() function instead of print statement throughout project 2017-12-10 10:51:07 -08:00
scripts Avoid installing tests to site-packages 2017-12-10 10:55:58 -08:00
tests Avoid installing tests to site-packages 2017-12-10 10:55:58 -08:00
.appveyor.yml Avoid installing tests to site-packages 2017-12-10 10:55:58 -08:00
.gitignore Add *.egg-info directories to .gitignore 2017-12-01 18:21:50 -08:00
.travis.yml Avoid installing tests to site-packages 2017-12-10 10:55:58 -08: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 Trim trailing whitespace from all files throughout project 2017-12-01 21:42:14 -08:00
Makefile Avoid installing tests to site-packages 2017-12-10 10:55:58 -08:00
MANIFEST.in Remove unused scripts maketypes.sh & buildtypes.py 2017-12-10 09:57:43 -08:00
NEWS Avoid installing tests to site-packages 2017-12-10 10:55:58 -08:00
psycopg2.cproj Remove unused scripts maketypes.sh & buildtypes.py 2017-12-10 09:57:43 -08: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 Avoid installing tests to site-packages 2017-12-10 10:55:58 -08:00
tox.ini Drop support for EOL Python 2.6 2017-11-28 16:02:12 +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/


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