psycopg/psycopg2
1
1
Fork 0
mirror of https://github.com/psycopg/psycopg2.git synced 2024-11-22 17:06:33 +03:00
Code Issues Packages Projects Releases Wiki Activity

A few corrections to the install page

Browse Source 
Spacing, lines length, a spurious link targed, reST formatting.
This commit is contained in:
Daniele Varrazzo 2020-08-24 01:44:45 +01:00
parent 9c30fdbc63
commit 82d679cdb3
1 changed files with 9 additions and 13 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
doc/src/install.rst
View File

@ -22,14 +22,17 @@ wrapper for the libpq_, the official PostgreSQL client library.
Quick Install Quick Install
------------- -------------
For most operating systems, the quickest way to install psycopg is using the wheel_ package available on PyPI_: For most operating systems, the quickest way to install Psycopg is using the
wheel_ package available on PyPI_:
.. code-block:: console .. code-block:: console
$ pip install psycopg2-binary $ pip install psycopg2-binary
This will install a pre-compiled binary version of the module which does not require the build or runtime prerequisites described below. Make sure to use an up-date-date version of :program:`pip` (you can upgrade it This will install a pre-compiled binary version of the module which does not
using something like ``pip install -U pip``). require the build or runtime prerequisites described below. Make sure to use
an up-date-date version of :program:`pip` (you can upgrade it using something
like ``pip install -U pip``).
You may then import the ``psycopg`` package, as usual: You may then import the ``psycopg`` package, as usual:
@ -49,10 +52,10 @@ You may then import the ``psycopg`` package, as usual:
# Retrieve query results # Retrieve query results
records = cur.fetchall() records = cur.fetchall()
.. __: PyPI-binary_
.. _PyPI: https://pypi.org/project/psycopg2-binary/ .. _PyPI: https://pypi.org/project/psycopg2-binary/
.. _wheel: https://pythonwheels.com/ .. _wheel: https://pythonwheels.com/
psycopg vs psycopg-binary psycopg vs psycopg-binary
^^^^^^^^^^^^^^^^^^^^^^^^^ ^^^^^^^^^^^^^^^^^^^^^^^^^
@ -61,10 +64,9 @@ with Python and PostgreSQL without the need to meet the build
requirements. requirements.
If you are the maintainer of a published package depending on `!psycopg2` If you are the maintainer of a published package depending on `!psycopg2`
you shouldn't use 'psycopg2-binary' as a module dependency. **For you shouldn't use ``psycopg2-binary`` as a module dependency. **For
production use you are advised to use the source distribution.** production use you are advised to use the source distribution.**
The binary packages come with their own versions of a few C libraries, The binary packages come with their own versions of a few C libraries,
among which ``libpq`` and ``libssl``, which will be used regardless of other among which ``libpq`` and ``libssl``, which will be used regardless of other
libraries available on the client: upgrading the system libraries will not libraries available on the client: upgrading the system libraries will not
@ -81,7 +83,6 @@ source if you want to maintain binary upgradeability.
advised to use a package built from source. advised to use a package built from source.
.. index:: .. index::
single: Install; disable wheel single: Install; disable wheel
single: Wheel; disable single: Wheel; disable
@ -219,10 +220,6 @@ which is OS-dependent (for instance setting a suitable
to connect to. to connect to.
.. index:: .. index::
single: setup.py single: setup.py
single: setup.cfg single: setup.cfg
@ -335,7 +332,6 @@ setting the environment variables:
The database should already exist before running the tests. The database should already exist before running the tests.
.. _other-problems: .. _other-problems:
If you still have problems If you still have problems