summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorAndy McCurdy <andy@andymccurdy.com>2018-11-12 13:57:37 -0800
committerGitHub <noreply@github.com>2018-11-12 13:57:37 -0800
commit27df0332608f5fa02406890ecfc0a99126ef4805 (patch)
tree979aa8a6954ae8ef3884f23903d356561c8fd8a8
parente9d48c9b93b489519608b8a2c4a988d431022617 (diff)
parent5c2cf460e0fefa0e6914adffcc60552d59242600 (diff)
downloadredis-py-27df0332608f5fa02406890ecfc0a99126ef4805.tar.gz
Merge pull request #1063 from andymccurdy/noreadmesudo
Removes `sudo` from README
-rw-r--r--README.rst11
1 files changed, 9 insertions, 2 deletions
diff --git a/README.rst b/README.rst
index fce61fd..7fd299c 100644
--- a/README.rst
+++ b/README.rst
@@ -16,17 +16,24 @@ 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 <https://bit.ly/py-env>`_.
+
To install redis-py, simply:
.. code-block:: bash
- $ sudo pip install redis
+ $ pip install redis
or from source:
.. code-block:: bash
- $ sudo python setup.py install
+ $ python setup.py install
Getting Started