Skip to content

Commit

Permalink
Improve installation documentation (#55)
Browse files Browse the repository at this point in the history
Point out the need for installation of libpq more clearly.
  • Loading branch information
Cito committed Nov 30, 2020
1 parent f4f6793 commit eab7387
Showing 1 changed file with 10 additions and 4 deletions.
14 changes: 10 additions & 4 deletions docs/contents/install.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,15 +7,18 @@ General
You must first install Python and PostgreSQL on your system.
If you want to access remote databases only, you don't need to install
the full PostgreSQL server, but only the libpq C-interface library.
If you are on Windows, make sure that the directory that contains
libpq.dll is part of your ``PATH`` environment variable.
On Windows, this library is called ``libpq.dll`` and is for instance contained
in the PostgreSQL ODBC driver (search for "psqlodbc"). On Linux, it is called
``libpq.so`` and usually provided in a package called "libpq" or "libpq5".
On Windows, you also need to make sure that the directory that contains
``libpq.dll`` is part of your ``PATH`` environment variable.

The current version of PyGreSQL has been tested with Python versions
2.7 and 3.5 to 3.9, and PostgreSQL versions 9.0 to 9.6 and 10 to 13.

PyGreSQL will be installed as three modules, a shared library called
_pg.so (on Linux) or a DLL called _pg.pyd (on Windows), and two pure
Python wrapper modules called pg.py and pgdb.py.
``_pg.so`` (on Linux) or a DLL called ``_pg.pyd`` (on Windows), and two pure
Python wrapper modules called ``pg.py`` and ``pgdb.py``.
All three files will be installed directly into the Python site-packages
directory. To uninstall PyGreSQL, simply remove these three files.

Expand All @@ -32,6 +35,9 @@ This will automatically try to find and download a distribution on the
`Python Package Index <https://pypi.python.org/>`_ that matches your operating
system and Python version and install it.

Note that you still need to have the libpq interface installed on your system
(see the general remarks above).


Installing from a Binary Distribution
-------------------------------------
Expand Down

0 comments on commit eab7387

Please sign in to comment.