2014-08-22 09:08:38 +04: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
|
|
|
|
|
-------------
|
|
|
|
|
|
2017-03-13 15:13:47 +03:00
|
|
|
Documentation is included in the ``doc`` directory and is `available online`__.
|
2014-08-22 09:08:38 +04:00
|
|
|
|
|
|
|
|
.. __: http://initd.org/psycopg/docs/
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
Installation
|
|
|
|
|
------------
|
|
|
|
|
|
2017-02-16 20:17:13 +03:00
|
|
|
If your ``pip`` version supports wheel_ packages it should be possible to
|
2017-03-13 15:13:47 +03:00
|
|
|
install a binary version of Psycopg including all the dependencies from PyPI_.
|
|
|
|
|
Just run::
|
2017-02-16 20:17:13 +03:00
|
|
|
|
2017-03-13 15:13:47 +03:00
|
|
|
$ pip install -U pip # make sure your pip is up-to-date
|
|
|
|
|
$ pip install psycopg2
|
2017-02-16 20:17:13 +03:00
|
|
|
|
2017-03-13 15:13:47 +03:00
|
|
|
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.
|
2014-08-25 02:33:14 +04:00
|
|
|
|
2017-02-16 20:17:13 +03:00
|
|
|
.. _wheel: http://pythonwheels.com/
|
2017-03-13 15:13:47 +03:00
|
|
|
.. _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
|
2014-08-22 09:08:38 +04:00
|
|
|
|
|
|
|
|
For any other resource (source code repository, bug tracker, mailing list)
|
|
|
|
|
please check the `project homepage`__.
|
|
|
|
|
|
|
|
|
|
.. __: http://initd.org/psycopg/
|
2016-12-24 06:28:34 +03:00
|
|
|
|
|
|
|
|
|
2017-02-16 18:59:37 +03:00
|
|
|
:Linux/OSX: |travis|
|
|
|
|
|
:Windows: |appveyor|
|
|
|
|
|
|
|
|
|
|
.. |travis| image:: https://travis-ci.org/psycopg/psycopg2.svg?branch=master
|
2016-12-24 06:28:34 +03:00
|
|
|
:target: https://travis-ci.org/psycopg/psycopg2
|
2017-02-16 18:59:37 +03:00
|
|
|
:alt: Linux and OSX build status
|
|
|
|
|
|
2017-02-24 04:49:45 +03:00
|
|
|
.. |appveyor| image:: https://ci.appveyor.com/api/projects/status/github/psycopg/psycopg2?branch=master&svg=true
|
2017-02-16 18:59:37 +03:00
|
|
|
:target: https://ci.appveyor.com/project/psycopg/psycopg2
|
|
|
|
|
:alt: Windows build status
|
