summaryrefslogtreecommitdiff
path: root/docs/narr/install.rst
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2016-09-24 20:39:45 -0700
committerSteve Piercy <web@stevepiercy.com>2016-09-24 20:39:45 -0700
commit21f2b61272f83de110087344e68f32953cd7b42f (patch)
tree4ba670ff6f3634e1cd063e98a41e2c71b267b703 /docs/narr/install.rst
parent5b33ff66090e4f2b0249cc85341cce09d0b57fca (diff)
downloadpyramid-21f2b61272f83de110087344e68f32953cd7b42f.tar.gz
pyramid-21f2b61272f83de110087344e68f32953cd7b42f.tar.bz2
pyramid-21f2b61272f83de110087344e68f32953cd7b42f.zip
Why use venv/bin/pip instead of source bin/activate then pip?
- Closes #2610
Diffstat (limited to 'docs/narr/install.rst')
-rw-r--r--docs/narr/install.rst21
1 files changed, 21 insertions, 0 deletions
diff --git a/docs/narr/install.rst b/docs/narr/install.rst
index 677c27e4a..7b5d8361b 100644
--- a/docs/narr/install.rst
+++ b/docs/narr/install.rst
@@ -191,6 +191,24 @@ After installing Python as described previously in :ref:`for-mac-os-x-users` or
$ $VENV/bin/pip install "pyramid==\ |release|\ "
+.. index::
+ single: $VENV/bin/pip vs. source bin/activate
+
+.. _venv-bin-pip-vs-source-bin-activate:
+
+.. note:: Why use ``$VENV/bin/pip`` instead of ``source bin/activate``, then
+ ``pip``?
+
+ Although the latter method requires fewer key strokes to issue commands once
+ invoked, there are numerous reasons why one should avoid using ``activate``
+ within a virtual environment. Michael F. Lamb (datagrok) presents a summary
+ in `Virtualenv's bin/activate is Doing It Wrong
+ <https://gist.github.com/datagrok/2199506>`_, and proposes alternatives,
+ followed by comments from other developers.
+
+ However, we prefer to keep things simple. ``$VENV/bin/pip`` is already
+ UNIX-y. The few extra key strokes are worth avoiding the mess altogether.
+
.. index::
single: installing on Windows
@@ -227,6 +245,9 @@ After installing Python as described previously in
c:\\> %VENV%\\Scripts\\pip install "pyramid==\ |release|\ "
+.. note:: See the note above for :ref:`Why use $VENV/bin/pip instead of source
+ bin/activate, then pip <venv-bin-pip-vs-source-bin-activate>`.
+
What Gets Installed
-------------------