From d7ee69d2f28da5f08dd8a261bb1f205187a2add2 Mon Sep 17 00:00:00 2001 From: Jon Dufresne Date: Fri, 29 May 2020 04:50:04 -0700 Subject: [PATCH] [3.1.x] Fixed #31643 -- Changed virtualenv doc references to Python 3 venv. Backport of 9f4ceee90aaa2a6af8321417d79330f2fdc620ea from master --- docs/howto/deployment/wsgi/modwsgi.txt | 9 ++++----- docs/howto/deployment/wsgi/uwsgi.txt | 4 ++-- docs/howto/upgrade-version.txt | 6 +++--- docs/internals/howto-release-django.txt | 13 +++++++------ docs/intro/contributing.txt | 5 +---- docs/intro/reusable-apps.txt | 16 ++++++++-------- docs/spelling_wordlist | 2 -- docs/topics/install.txt | 17 ++++++++--------- 8 files changed, 33 insertions(+), 39 deletions(-) diff --git a/docs/howto/deployment/wsgi/modwsgi.txt b/docs/howto/deployment/wsgi/modwsgi.txt index cbc19628bb..97c261f100 100644 --- a/docs/howto/deployment/wsgi/modwsgi.txt +++ b/docs/howto/deployment/wsgi/modwsgi.txt @@ -48,9 +48,9 @@ your project package (``mysite`` in this example). This tells Apache to serve any request below the given URL using the WSGI application defined in that file. -If you install your project's Python dependencies inside a `virtualenv`_, add -the path to the virtualenv using ``WSGIPythonHome``. See the `mod_wsgi -virtualenv guide`_ for more details. +If you install your project's Python dependencies inside a :mod:`virtual +environment `, add the path using ``WSGIPythonHome``. See the `mod_wsgi +virtual environment guide`_ for more details. The ``WSGIPythonPath`` line ensures that your project package is available for import on the Python path; in other words, that ``import mysite`` works. @@ -64,8 +64,7 @@ for you; otherwise, you'll need to create it. See the :doc:`WSGI overview documentation` for the default contents you should put in this file, and what else you can add to it. -.. _virtualenv: https://virtualenv.pypa.io/ -.. _mod_wsgi virtualenv guide: https://modwsgi.readthedocs.io/en/develop/user-guides/virtual-environments.html +.. _mod_wsgi virtual environment guide: https://modwsgi.readthedocs.io/en/develop/user-guides/virtual-environments.html .. warning:: diff --git a/docs/howto/deployment/wsgi/uwsgi.txt b/docs/howto/deployment/wsgi/uwsgi.txt index 43cfdf3b93..6e66189b4e 100644 --- a/docs/howto/deployment/wsgi/uwsgi.txt +++ b/docs/howto/deployment/wsgi/uwsgi.txt @@ -60,7 +60,7 @@ Here's an example command to start a uWSGI server:: --harakiri=20 \ # respawn processes taking more than 20 seconds --max-requests=5000 \ # respawn processes after serving 5000 requests --vacuum \ # clear environment on exit - --home=/path/to/virtual/env \ # optional path to a virtualenv + --home=/path/to/virtual/env \ # optional path to a virtual environment --daemonize=/var/log/uwsgi/yourproject.log # background the process This assumes you have a top-level project package named ``mysite``, and @@ -78,7 +78,7 @@ The Django-specific options here are: * ``module``: The WSGI module to use -- probably the ``mysite.wsgi`` module that :djadmin:`startproject` creates. * ``env``: Should probably contain at least :envvar:`DJANGO_SETTINGS_MODULE`. -* ``home``: Optional path to your project virtualenv. +* ``home``: Optional path to your project virtual environment. Example ini configuration file:: diff --git a/docs/howto/upgrade-version.txt b/docs/howto/upgrade-version.txt index 007df6459c..bde9b18c1b 100644 --- a/docs/howto/upgrade-version.txt +++ b/docs/howto/upgrade-version.txt @@ -87,8 +87,9 @@ Installation ============ Once you're ready, it is time to :doc:`install the new Django version -`. If you are using virtualenv_ and it is a major upgrade, you -might want to set up a new environment with all the dependencies first. +`. If you are using a :mod:`virtual environment ` and it +is a major upgrade, you might want to set up a new environment with all the +dependencies first. If you installed Django with pip_, you can use the ``--upgrade`` or ``-U`` flag: @@ -97,7 +98,6 @@ If you installed Django with pip_, you can use the ``--upgrade`` or ``-U`` flag: $ python -m pip install -U Django .. _pip: https://pip.pypa.io/ -.. _virtualenv: https://virtualenv.pypa.io/ Testing ======= diff --git a/docs/internals/howto-release-django.txt b/docs/internals/howto-release-django.txt index 22fb393810..0305af8007 100644 --- a/docs/internals/howto-release-django.txt +++ b/docs/internals/howto-release-django.txt @@ -305,26 +305,27 @@ Now you're ready to actually put the release out there. To do this: $ scp Django-A.B.C.checksum.txt.asc djangoproject.com:/home/www/www/media/pgp/Django-A.B.C.checksum.txt #. Test that the release packages install correctly using ``easy_install`` - and ``pip``. Here's one method (which requires `virtualenvwrapper`__):: + and ``pip``. Here's one method:: $ RELEASE_VERSION='1.7.2' $ MAJOR_VERSION=`echo $RELEASE_VERSION| cut -c 1-3` - $ mktmpenv + $ python -m venv django-easy-install + $ . django-easy-install/bin/activate $ easy_install https://www.djangoproject.com/m/releases/$MAJOR_VERSION/Django-$RELEASE_VERSION.tar.gz $ deactivate - $ mktmpenv + $ python -m venv django-pip + $ . django-pip/bin/activate $ python -m pip install https://www.djangoproject.com/m/releases/$MAJOR_VERSION/Django-$RELEASE_VERSION.tar.gz $ deactivate - $ mktmpenv + $ python -m venv django-pip-wheel + $ . django-pip-wheel/bin/activate $ python -m pip install https://www.djangoproject.com/m/releases/$MAJOR_VERSION/Django-$RELEASE_VERSION-py3-none-any.whl $ deactivate This just tests that the tarballs are available (i.e. redirects are up) and that they install correctly, but it'll catch silly mistakes. - __ https://pypi.org/project/virtualenvwrapper/ - #. Ask a few people on IRC to verify the checksums by visiting the checksums file (e.g. https://www.djangoproject.com/m/pgp/Django-1.5b1.checksum.txt) and following the instructions in it. For bonus points, they can also unpack diff --git a/docs/intro/contributing.txt b/docs/intro/contributing.txt index 78d904440b..9612cd763e 100644 --- a/docs/intro/contributing.txt +++ b/docs/intro/contributing.txt @@ -152,8 +152,7 @@ If the ``source`` command is not available, you can try using a dot instead: $ . ~/.virtualenvs/djangodev/bin/activate You have to activate the virtual environment whenever you open a new -terminal window. virtualenvwrapper__ is a useful tool for making this -more convenient. +terminal window. .. admonition:: For Windows users @@ -163,8 +162,6 @@ more convenient. ...\> %HOMEPATH%\.virtualenvs\djangodev\Scripts\activate.bat -__ https://virtualenvwrapper.readthedocs.io/en/latest/ - The name of the currently activated virtual environment is displayed on the command line to help you keep track of which one you are using. Anything you install through ``pip`` while this name is displayed will be installed in that diff --git a/docs/intro/reusable-apps.txt b/docs/intro/reusable-apps.txt index 3bc0188332..c326886803 100644 --- a/docs/intro/reusable-apps.txt +++ b/docs/intro/reusable-apps.txt @@ -277,8 +277,8 @@ working. We'll now fix this by installing our new ``django-polls`` package. users of the machine. Note that per-user installations can still affect the behavior of system - tools that run as that user, so ``virtualenv`` is a more robust solution - (see below). + tools that run as that user, so using a virtual environment is a more robust + solution (see below). #. To install the package, use pip (you already :ref:`installed it `, right?):: @@ -307,8 +307,8 @@ the world! If this wasn't just an example, you could now: tutorial `_ for doing this. -Installing Python packages with virtualenv -========================================== +Installing Python packages with a virtual environment +===================================================== Earlier, we installed the polls app as a user library. This has some disadvantages: @@ -319,7 +319,7 @@ disadvantages: the same name). Typically, these situations only arise once you're maintaining several Django -projects. When they do, the best solution is to use `virtualenv -`_. This tool allows you to maintain multiple -isolated Python environments, each with its own copy of the libraries and -package namespace. +projects. When they do, the best solution is to use :doc:`venv +`. This tool allows you to maintain multiple isolated +Python environments, each with its own copy of the libraries and package +namespace. diff --git a/docs/spelling_wordlist b/docs/spelling_wordlist index 2fa544ec38..fc33877c86 100644 --- a/docs/spelling_wordlist +++ b/docs/spelling_wordlist @@ -778,8 +778,6 @@ versioned versioning vertices viewable -virtualenv -virtualenvs virtualized Weblog whitelist diff --git a/docs/topics/install.txt b/docs/topics/install.txt index 3ce3dc2f1c..7dab429319 100644 --- a/docs/topics/install.txt +++ b/docs/topics/install.txt @@ -137,11 +137,11 @@ This is the recommended way to install Django. it's outdated. If it's outdated, you'll know because installation won't work. -#. Take a look at virtualenv_ and virtualenvwrapper_. These tools provide +#. Take a look at :doc:`venv `. This tool provides isolated Python environments, which are more practical than installing - packages systemwide. They also allow installing packages without + packages systemwide. It also allows installing packages without administrator privileges. The :doc:`contributing tutorial - ` walks through how to create a virtualenv. + ` walks through how to create a virtual environment. #. After you've created and activated a virtual environment, enter the command: @@ -150,8 +150,6 @@ This is the recommended way to install Django. $ python -m pip install Django .. _pip: https://pip.pypa.io/ -.. _virtualenv: https://virtualenv.pypa.io/ -.. _virtualenvwrapper: https://virtualenvwrapper.readthedocs.io/en/latest/ .. _standalone pip installer: https://pip.pypa.io/en/latest/installing/#installing-with-get-pip-py .. _installing-distribution-package: @@ -198,11 +196,12 @@ latest bug fixes and improvements, follow these instructions: This will create a directory ``django`` in your current directory. #. Make sure that the Python interpreter can load Django's code. The most - convenient way to do this is to use virtualenv_, virtualenvwrapper_, and - pip_. The :doc:`contributing tutorial ` walks through - how to create a virtualenv. + convenient way to do this is to use a virtual environment and pip_. The + :doc:`contributing tutorial ` walks through how to + create a virtual environment. -#. After setting up and activating the virtualenv, run the following command: +#. After setting up and activating the virtual environment, run the following + command: .. console::