]> git.ipfire.org Git - thirdparty/Python/cpython.git/commitdiff
gh-109414: Add some basic information about venvs in the introduction. (GH-109440)
authorVinay Sajip <vinay_sajip@yahoo.co.uk>
Sat, 16 Sep 2023 08:49:02 +0000 (09:49 +0100)
committerGitHub <noreply@github.com>
Sat, 16 Sep 2023 08:49:02 +0000 (09:49 +0100)
Co-authored-by: Victor Stinner <vstinner@python.org>
Doc/library/venv.rst

index b72f3041f1da116ccacef5b8351ade002fafec31..da8942c554dea10c6684e5cf262b5db1158a81db 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::