From: Daniele Varrazzo Date: Wed, 25 Aug 2021 02:02:30 +0000 (+0200) Subject: Readmes and metadata cleanup X-Git-Tag: 3.0.beta1~40 X-Git-Url: http://git.ipfire.org/gitweb.cgi?a=commitdiff_plain;h=cc4ea4958621cbf8d6aa91f316bc3a31e1bb05ff;p=thirdparty%2Fpsycopg.git Readmes and metadata cleanup --- diff --git a/README.rst b/README.rst index 0e595a620..29de2676a 100644 --- a/README.rst +++ b/README.rst @@ -59,15 +59,21 @@ different requirements: .. __: https://www.psycopg.org/psycopg3/docs/basic/install.html#local-installation +- The ``psycopg_pool`` directory contains the `connection pools`__ + implementations. This is kept as a separate package to allow a different + release cycle. + + .. __: https://www.psycopg.org/psycopg3/docs/advanced/pool.html + You can create a local virtualenv and install there the packages `in development mode`__, together with their development and testing requirements:: python -m venv .venv source .venv/bin/activate - pip install -e ./psycopg[dev,test] # for the base Python package - pip install -e ./psycopg_c # for the C extension module - pip install -e ./psycopg_pool --no-deps # for the connection pool + pip install -e ./psycopg[dev,test] # for the base Python package + pip install -e ./psycopg_c # for the C extension module + pip install -e ./psycopg_pool # for the connection pool .. __: https://pip.pypa.io/en/stable/reference/pip_install/#install-editable diff --git a/psycopg/README.rst b/psycopg/README.rst index 448643bd3..07d3e741a 100644 --- a/psycopg/README.rst +++ b/psycopg/README.rst @@ -5,7 +5,25 @@ Psycopg 3 is a modern implementation of a PostgreSQL adapter for Python. This distribution contains the pure Python package ``psycopg``. -Please check out `the project readme`__ for more details. + +Installation +------------ + +In short, run the following:: + + pip install -U pip # to upgrade pip + pip install psycopg[binary,pool] # to install package and dependencies + +If something goes wrong, and for more information about installation, please +check out the `Installation documentation`__. + +.. __: https://www.psycopg.org/psycopg3/docs/basic/install.html# + + +Hacking +------- + +For development information check out `the project readme`__. .. __: https://github.com/psycopg/psycopg#readme diff --git a/psycopg_c/README-binary.rst b/psycopg_c/README-binary.rst index 213cb6f58..7dad6b269 100644 --- a/psycopg_c/README-binary.rst +++ b/psycopg_c/README-binary.rst @@ -8,6 +8,17 @@ You shouldn't install this package directly: use instead :: pip install psycopg[binary] +to install a version of the optimization package matching the ``psycopg`` +version installed. + +Installing this package requires pip >= 20.3 or newer installed. + +This package is not available for every platform: check out `Binary +installation`__ in the documentation. + +.. __: https://www.psycopg.org/psycopg3/docs/basic/install.html + #binary-installation + Please read `the project readme`__ and `the installation documentation`__ for more details. diff --git a/psycopg_c/README.rst b/psycopg_c/README.rst index 52ea8805d..d548e0c49 100644 --- a/psycopg_c/README.rst +++ b/psycopg_c/README.rst @@ -7,6 +7,22 @@ You shouldn't install this package directly: use instead :: pip install psycopg[c] +to install a version of the optimization package matching the ``psycopg`` +version installed. + +Installing this package requires some prerequisites: check `Local +installation`__ in the documentation. Without a C compiler and some library +headers install *will fail*: this is not a bug. + +If you are unable to meet the prerequisite needed you might want to install +``psycopg[binary]`` instead: look for `Binary installation`__ in the +documentation. + +.. __: https://www.psycopg.org/psycopg3/docs/basic/install.html + #local-installation +.. __: https://www.psycopg.org/psycopg3/docs/basic/install.html + #binary-installation + Please read `the project readme`__ and `the installation documentation`__ for more details. diff --git a/psycopg_c/setup.cfg b/psycopg_c/setup.cfg index 4e66ecdcb..fbf4fcada 100644 --- a/psycopg_c/setup.cfg +++ b/psycopg_c/setup.cfg @@ -12,7 +12,6 @@ project_urls = Issue Tracker = https://github.com/psycopg/psycopg/issues Download = https://pypi.org/project/psycopg-c/ -# TODO: classifiers classifiers = Development Status :: 3 - Alpha Intended Audience :: Developers diff --git a/psycopg_pool/README.rst b/psycopg_pool/README.rst index 15b46f8fe..fa8271b8d 100644 --- a/psycopg_pool/README.rst +++ b/psycopg_pool/README.rst @@ -2,7 +2,12 @@ Psycopg 3: PostgreSQL database adapter for Python - Connection Pool =================================================================== This distribution contains the optional connection pool package -``psycopg_pool``. +`psycopg_pool`__. + +.. __: https://www.psycopg.org/psycopg3/docs/advanced/pool.html + +This package is kept separate from the main ``psycopg`` package because it is +likely that it will follow a different release cycle. You can also install this package using:: @@ -13,6 +18,7 @@ more details. .. __: https://github.com/psycopg/psycopg#readme .. __: https://www.psycopg.org/psycopg3/docs/basic/install.html + #installing-the-connection-pool Copyright (C) 2020-2021 The Psycopg Team diff --git a/psycopg_pool/setup.cfg b/psycopg_pool/setup.cfg index a68d3162d..8a0bb2ef6 100644 --- a/psycopg_pool/setup.cfg +++ b/psycopg_pool/setup.cfg @@ -10,7 +10,7 @@ project_urls = Homepage = https://psycopg.org/ Code = https://github.com/psycopg/psycopg Issue Tracker = https://github.com/psycopg/psycopg/issues - Download = https://pypi.org/project/psycopg/ + Download = https://pypi.org/project/psycopg-pool/ classifiers = Development Status :: 3 - Alpha