diff options
| author | Alexander Zawadzki <alexander.zawadzki@gmail.com> | 2019-05-30 18:03:47 +0100 |
|---|---|---|
| committer | Irina Truong <i.chernyavska@gmail.com> | 2019-05-30 10:03:47 -0700 |
| commit | df4dd005857aba57353d7ff35040712ddc60c5bb (patch) | |
| tree | eab28f33b6c579b1080abd7f549f24f813d97467 | |
| parent | 8c597751fdbc5a7082ec6f3053c1b066bbac5b3e (diff) | |
README.rst: tidy up redundant instructions (#1061)
* README.rst: tidy up redundant instructions
Remove the README section which detailed how to force `psycopg2` 2.7 dependency installation from source rather than binary.
`psycopg2` 2.7 would automatically favour installation from binary. A bug affecting some users made it desirable to have the option to install from source instead. The README detailed how to do this using pip's `--no-binary` option (nice!).
`psycopg2` 2.8 has now split the binary and source dependencies into different packages with different names (source: [psycopg2 docs](http://initd.org/psycopg/docs/install.html#change-in-binary-packages-between-psycopg-2-7-and-2-8)) which makes the `--no-binary` instructions redundant. To specify source/binary you now need to explicitly specify the desired package.
As of #1060, installing `pgcli` from pip will result in the installation of `psycopg2` 2.8 from source.
* README: additional instructions for psycopg2 2.7 users
Anyone limited to psycopg2 2.7 may still encounter some known issues when installing from binary.
Add a link to the README to acknowledge this, and help those users install it from source.
* Update changelog.rst
* Update AUTHORS
* Update changelog
| -rw-r--r-- | AUTHORS | 1 | ||||
| -rw-r--r-- | README.rst | 9 | ||||
| -rw-r--r-- | changelog.rst | 2 |
3 files changed, 5 insertions, 7 deletions
@@ -96,6 +96,7 @@ Contributors: * Zhaolong Zhu * Zane C. Bowers-Hadley * Telmo "Trooper" (telmotrooper) + * Alexander Zawadzki Creator: -------- @@ -29,15 +29,10 @@ If you already know how to install python packages, then you can simply do: If you don't know how to install python packages, please check the `detailed instructions`_. -If you have `problems with psycopg2 wheels`_, use the following flags to install psycopg2 from -source: - -:: - - $ pip install pgcli --no-binary :all: psycopg2 +If you are restricted to using psycopg2 2.7.x then pip will try to install it from a binary. There are some known issues with the psycopg2 2.7 binary - see the `psycopg docs`_ for more information about this and how to force installation from source. psycopg2 2.8 has fixed these problems, and will build from source. .. _`detailed instructions`: https://github.com/dbcli/pgcli#detailed-installation-instructions -.. _`problems with psycopg2 wheels`: http://initd.org/psycopg/articles/2018/02/08/psycopg-274-released/ +.. _`psycopg docs`: http://initd.org/psycopg/docs/install.html#change-in-binary-packages-between-psycopg-2-7-and-2-8 Usage ----- diff --git a/changelog.rst b/changelog.rst index 3331eeb2..f597f56d 100644 --- a/changelog.rst +++ b/changelog.rst @@ -12,6 +12,7 @@ Bug fixes: * Fix the broken support for pgservice . (Thanks: `Xavier Francisco`_) * Connecting using socket is broken in current master. (#1053). (Thanks: `Irina Truong`_) * Allow usage of newer versions of psycopg2 (Thanks: `Telmo "Trooper"`_) +* Update README in alignment with the usage of newer versions of psycopg2 (Thanks: `Alexander Zawadzki`_) Internal: --------- @@ -977,3 +978,4 @@ Improvements: .. _`Xavier Francisco`: https://github.com/Qu4tro .. _`VVelox`: https://github.com/VVelox .. _`Telmo "Trooper"`: https://github.com/telmotrooper +.. _`Alexander Zawadzki`: https://github.com/zadacka |