diff --git a/Doc/library/venv.rst b/Doc/library/venv.rst index bed799aedfdfb1..7575e45f6cc8a9 100644 --- a/Doc/library/venv.rst +++ b/Doc/library/venv.rst @@ -64,6 +64,8 @@ See :pep:`405` for more background on Python virtual environments. Creating virtual environments ----------------------------- +.. program:: venv + :ref:`Virtual environments ` are created by executing the ``venv`` module: @@ -81,21 +83,6 @@ It also creates a :file:`lib/pythonX.Y/site-packages` subdirectory (on Windows, this is :file:`Lib\site-packages`). If an existing directory is specified, it will be re-used. -.. versionchanged:: 3.5 - The use of ``venv`` is now recommended for creating virtual environments. - -.. deprecated-removed:: 3.6 3.8 - :program:`pyvenv` was the recommended tool for creating virtual environments - for Python 3.3 and 3.4, and replaced in 3.5 by executing ``venv`` directly. - -.. highlight:: none - -On Windows, invoke the ``venv`` command as follows: - -.. code-block:: ps1con - - PS> python -m venv C:\path\to\new\virtual\environment - The command, if run with ``-h``, will show the available options:: usage: venv [-h] [--system-site-packages] [--symlinks | --copies] [--clear] @@ -135,6 +122,42 @@ The command, if run with ``-h``, will show the available options:: Once an environment has been created, you may wish to activate it, e.g. by sourcing an activate script in its bin directory. +.. option:: --system-site-packages + + Give the virtual environment access to the system site-packages directory. + +.. option:: --symlinks + + Try to use symlinks rather than copies, when symlinks are not the default for the platform. + +.. option:: --copies + + Try to use copies rather than symlinks, even when symlinks are the default for the platform. + +.. option:: --clear + + Delete the contents of the environment directory if it already exists, before environment creation. + +.. option:: --upgrade + + Upgrade the environment directory to use this version of Python, assuming Python has been upgraded in-place. + +.. option:: --without-pip + + Skips installing or upgrading pip in the virtual environment (pip is bootstrapped by default). + +.. option:: --prompt + + Provides an alternative prompt prefix for this environment. + +.. option:: --upgrade-deps + + Upgrade core dependencies (pip) to the latest version in PyPI. + +.. option:: --without-scm-ignore-files + + Skips adding SCM ignore files to the environment directory (Git is supported by default). + .. versionchanged:: 3.4 Installs pip by default, added the ``--without-pip`` and ``--copies``