summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorItamar Haber <itamar@redislabs.com>2018-11-12 18:49:25 +0200
committerGitHub <noreply@github.com>2018-11-12 18:49:25 +0200
commitef068dbb74869c87d55eb814da0061488b45c148 (patch)
treeb0d3e7218fa0f44117a4e96f17db06b74e36e228
parentaafdc7e4faffab807bcb6a53e1d38d61624006a0 (diff)
downloadredis-py-ef068dbb74869c87d55eb814da0061488b45c148.tar.gz
Warns against `sudo pip` and refers to venvs
-rw-r--r--README.rst7
1 files changed, 7 insertions, 0 deletions
diff --git a/README.rst b/README.rst
index 97a9d81..fe97e19 100644
--- a/README.rst
+++ b/README.rst
@@ -16,6 +16,13 @@ Installation
redis-py requires a running Redis server. See `Redis's quickstart
<https://redis.io/topics/quickstart>`_ for installation instructions.
+redis-py can be installed using `pip` similar to other Python packages. Do not use `sudo`
+with `pip`. It is usually good to work in a
+[virtualenv](https://virtualenv.pypa.io/en/latest/) or
+[venv](https://docs.python.org/3/library/venv.html) to avoid conflicts with other package
+managers and Python projects. For a quick introduction see
+[Python Virtual Environments in Five Minutes](bit.ly/py-env).
+
To install redis-py, simply:
.. code-block:: bash