summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorGeorge Lund <george.lund@digital.cabinet-office.gov.uk>2017-10-03 10:05:53 +0100
committerBernat Gabor <bgabor8@bloomberg.net>2018-12-26 12:19:40 +0200
commit06c05f89b20f0c3d426f846368941a20ea7df109 (patch)
treecb1cad6e22a094ec78b848274035ca9bbc7c367f
parent49ad202eb0aba59733d55ca7b0d70b9974abf555 (diff)
downloadvirtualenv-06c05f89b20f0c3d426f846368941a20ea7df109.tar.gz
Link to Python 3 venv
The lack of a pointer here to `venv` is a source of confusion to people coming fresh to Python, who will often see this documentation quoted or referenced from existing material. I think this would be an important enough change to warrant updating the stable release.
-rw-r--r--docs/index.rst7
1 files changed, 6 insertions, 1 deletions
diff --git a/docs/index.rst b/docs/index.rst
index 91a358c..30ec505 100644
--- a/docs/index.rst
+++ b/docs/index.rst
@@ -11,7 +11,9 @@ Dev IRC: #pypa-dev
Introduction
------------
-``virtualenv`` is a tool to create isolated Python environments.
+``virtualenv`` is a tool to create isolated Python environments. Since
+Python 3.3 it has been replaced by the `venv
+module <https://docs.python.org/3/library/venv.html>`_.
The basic problem being addressed is one of dependencies and versions,
and indirectly permissions. Imagine you have an application that
@@ -91,6 +93,9 @@ Compare & Contrast with Alternatives
There are several alternatives that create isolated environments:
+* Python 3's `venv module <https://docs.python.org/3/library/venv.html>`_
+ is recommended for projects that no longer need to support Python 2.
+
* ``workingenv`` (which I do not suggest you use anymore) is the
predecessor to this library. It used the main Python interpreter,
but relied on setting ``$PYTHONPATH`` to activate the environment.