Skip to content

Commit

Permalink
gh-109414: Add some basic information about venvs in the introduction. (
Browse files Browse the repository at this point in the history
GH-109440)

Co-authored-by: Victor Stinner <[email protected]>
  • Loading branch information
vsajip and vstinner authored Sep 16, 2023
1 parent 0b38ce4 commit a6846d4
Showing 1 changed file with 19 additions and 0 deletions.
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

0 comments on commit a6846d4

Please sign in to comment.