summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>2023-09-17 20:50:12 (GMT)
committerGitHub <noreply@github.com>2023-09-17 20:50:12 (GMT)
commit655287996e01f92ca5a9d579f511991e41a41477 (patch)
treec3c06bc6960727652c6ab0f3dab1667502bc574d
parent02df0df97c01ee22b12fc543947396e5eb6d8854 (diff)
downloadcpython-655287996e01f92ca5a9d579f511991e41a41477.zip
cpython-655287996e01f92ca5a9d579f511991e41a41477.tar.gz
cpython-655287996e01f92ca5a9d579f511991e41a41477.tar.bz2
[3.12] gh-109414: Add some basic information about venvs in the introduction. (GH-109440) (#109481)
gh-109414: Add some basic information about venvs in the introduction. (GH-109440) (cherry picked from commit a6846d45ff3c836bc859c40e7684b57df991dc05) Co-authored-by: Vinay Sajip <vinay_sajip@yahoo.co.uk> Co-authored-by: Victor Stinner <vstinner@python.org>
-rw-r--r--Doc/library/venv.rst19
1 files changed, 19 insertions, 0 deletions
diff --git a/Doc/library/venv.rst b/Doc/library/venv.rst
index 2482441..18af1d4 100644
--- a/Doc/library/venv.rst
+++ b/Doc/library/venv.rst
@@ -30,6 +30,25 @@ When used from within a virtual environment, common installation tools such as
`pip`_ will install Python packages into a virtual environment
without needing to be told to do so explicitly.
+A virtual environment is (amongst other things):
+
+* Used to contain a specific Python interpreter and software libraries and
+ binaries which are needed to support a project (library or application). These
+ are by default isolated from software in other virtual environments and Python
+ interpreters and libraries installed in the operating system.
+
+* Contained in a directory, conventionally either named ``venv`` or ``.venv`` in
+ the project directory, or under a container directory for lots of virtual
+ environments, such as ``~/.virtualenvs``.
+
+* Not checked into source control systems such as Git.
+
+* Considered as disposable -- it should be simple to delete and recreate it from
+ scratch. You don't place any project code in the environment
+
+* Not considered as movable or copyable -- you just recreate the same
+ environment in the target location.
+
See :pep:`405` for more background on Python virtual environments.
.. seealso::