Skip to content

[3.11] gh-109414: Add some basic information about venvs in the introduction. (GH-109440) #109480

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Sep 16, 2023
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
19 changes: 19 additions & 0 deletions Doc/library/venv.rst
Original file line number Diff line number Diff line change
Expand Up @@ -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::
Expand Down