]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
[3.12] gh-109414: Add some basic information about venvs in the introduction. (GH...
authorMiss Islington (bot) <31488909+miss-islington@users.noreply.github.com>
Sun, 17 Sep 2023 20:50:12 +0000 (13:50 -0700)
committerGitHub <noreply@github.com>
Sun, 17 Sep 2023 20:50:12 +0000 (22:50 +0200)
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>
Doc/library/venv.rst

index 2482441d649790555eb4e6e2229f7e6f17794f2d..18af1d41e4044b3f123c1e3f6c32af1789a18d5d 100644 (file)
@@ -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::