summaryrefslogtreecommitdiff
path: root/docs
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2016-04-12 03:00:56 -0700
committerSteve Piercy <web@stevepiercy.com>2016-04-12 03:00:56 -0700
commit278afff7a9bbb42d96ac2199689c3141b9463b9c (patch)
tree2579157b840714e00202a1c7bb730d6849e4d7b6 /docs
parentf4013e4ed87d1ebec94756e07220b7ee273727b4 (diff)
parentb485166239091c620c96ca71369c69f6fa7a8be7 (diff)
downloadpyramid-278afff7a9bbb42d96ac2199689c3141b9463b9c.tar.gz
pyramid-278afff7a9bbb42d96ac2199689c3141b9463b9c.tar.bz2
pyramid-278afff7a9bbb42d96ac2199689c3141b9463b9c.zip
Merge pull request #2479 from stevepiercy/docs/easy-install-to-pip.2104
Docs/easy install to pip.2104
Diffstat (limited to 'docs')
-rw-r--r--docs/glossary.rst16
-rw-r--r--docs/narr/commandline.rst4
-rw-r--r--docs/narr/install.rst12
-rw-r--r--docs/quick_tour.rst4
-rw-r--r--docs/quick_tutorial/requirements.rst24
5 files changed, 30 insertions, 30 deletions
diff --git a/docs/glossary.rst b/docs/glossary.rst
index 1d8e0de1b..fd32ed796 100644
--- a/docs/glossary.rst
+++ b/docs/glossary.rst
@@ -1100,10 +1100,16 @@ Glossary
checker, and applying a renderer to a dictionary returned from the view.
pip
- The `Python Packaging Authority <https://www.pypa.io/>`_ recommended tool
- for installing Python packages.
+ The `Python Packaging Authority's <https://www.pypa.io/>`_ recommended
+ tool for installing Python packages.
pyvenv
- The Python Packaging Authority's recommended command for `creating
- virtual environments on Python 3.4 and greater
- <https://packaging.python.org/en/latest/installing/#creating-virtual-environments>`_.
+ The Python Packaging Authority formerly recommended using this command
+ for `creating virtual environments on Python 3.4 and 3.5
+ <https://packaging.python.org/en/latest/installing/#creating-virtual-environments>`_,
+ but it is deprecated in 3.6 in favor of ``python3 -m venv`` which is
+ backward compatible.
+
+ venv
+ The `Python Packaging Authority's <https://www.pypa.io/>`_ recommended
+ tool for creating virtual environments.
diff --git a/docs/narr/commandline.rst b/docs/narr/commandline.rst
index bc04f4c7a..3e164ee8d 100644
--- a/docs/narr/commandline.rst
+++ b/docs/narr/commandline.rst
@@ -578,10 +578,10 @@ Using Custom Arguments to Python when Running ``p*`` Scripts
.. versionadded:: 1.5
Each of Pyramid's console scripts (``pserve``, ``pviews``, etc.) can be run
-directly using ``python -m``, allowing custom arguments to be sent to the
+directly using ``python3 -m``, allowing custom arguments to be sent to the
Python interpreter at runtime. For example::
- python -3 -m pyramid.scripts.pserve development.ini
+ python3 -m pyramid.scripts.pserve development.ini
.. index::
diff --git a/docs/narr/install.rst b/docs/narr/install.rst
index 5e2abb236..548d040f1 100644
--- a/docs/narr/install.rst
+++ b/docs/narr/install.rst
@@ -5,8 +5,8 @@ Installing :app:`Pyramid`
.. note::
- This installation guide now emphasizes the use of Python 3.4 and greater
- for simplicity.
+ This installation guide emphasizes the use of Python 3.4 and greater for
+ simplicity.
.. index::
@@ -126,8 +126,8 @@ also need to download and install the Python for Windows extensions.
Requirements for Installing Packages
------------------------------------
-Use :term:`pip` for installing packages and :term:`pyvenv` for creating a
-virtual environment. A virtual environment is a semi-isolated Python
+Use :term:`pip` for installing packages and ``python3 -m venv env`` for
+creating a virtual environment. A virtual environment is a semi-isolated Python
environment that allows packages to be installed for use by a particular
application, rather than being installed system wide.
@@ -155,7 +155,7 @@ After installing Python as described previously in :ref:`for-mac-os-x-users` or
.. code-block:: bash
$ export VENV=~/env
- $ pyvenv $VENV
+ $ python3 -m venv $VENV
You can either follow the use of the environment variable ``$VENV``, or
replace it with the root directory of the virtual environment. If you choose
@@ -190,7 +190,7 @@ After installing Python as described previously in
c:\> set VENV=c:\env
# replace "x" with your minor version of Python 3
- c:\> c:\Python3x\Scripts\pyvenv %VENV%
+ c:\> c:\Python3x\Scripts\python3 -m venv %VENV%
You can either follow the use of the environment variable ``%VENV%``, or
replace it with the root directory of the virtual environment. If you choose
diff --git a/docs/quick_tour.rst b/docs/quick_tour.rst
index f1cec97e9..e381a9232 100644
--- a/docs/quick_tour.rst
+++ b/docs/quick_tour.rst
@@ -25,7 +25,7 @@ As an example, for Python 3.5+ on Linux:
.. parsed-literal::
- $ pyvenv env
+ $ python3 -m venv env
$ env/bin/pip install pyramid
# or for a specific released version
$ env/bin/pip install "pyramid==\ |release|\ "
@@ -34,7 +34,7 @@ For Windows:
.. parsed-literal::
- c:\\> c:\\Python35\\python -m venv env
+ c:\\> c:\\Python35\\python3 -m venv env
c:\\> env\\Scripts\\pip install pyramid
# or for a specific released version
c:\\> env\\Scripts\\pip install "pyramid==\ |release|\ "
diff --git a/docs/quick_tutorial/requirements.rst b/docs/quick_tutorial/requirements.rst
index c4e6beecb..17ce845e2 100644
--- a/docs/quick_tutorial/requirements.rst
+++ b/docs/quick_tutorial/requirements.rst
@@ -22,9 +22,9 @@ This *Quick Tutorial* is based on:
* **Python 3.5**. Pyramid fully supports Python 3.3+ and Python 2.6+. This
tutorial uses **Python 3.5** but runs fine under Python 2.7.
-* **pyvenv**. We believe in virtual environments. For this tutorial, we use
- Python 3.5's built-in solution, the ``pyvenv`` command. For Python 2.7, you
- can install ``virtualenv``.
+* **venv**. We believe in virtual environments. For this tutorial, we use
+ Python 3.5's built-in solution ``venv``. For Python 2.7, you can install
+ ``virtualenv``.
* **pip**. We use ``pip`` for package management.
@@ -158,26 +158,20 @@ environment. We set an environment variable to save typing later.
Create a Virtual Environment
----------------------------
-.. warning:: The current state of isolated Python environments using
- ``pyvenv`` on Windows is suboptimal in comparison to Mac and Linux. See
- http://stackoverflow.com/q/15981111/95735 for a discussion of the issue
- and `PEP 453 <http://www.python.org/dev/peps/pep-0453/>`_ for a proposed
- resolution.
-
-``pyvenv`` is a tool to create isolated Python 3 environments, each
-with its own Python binary and independent set of installed Python
-packages in its site directories. Let's create one, using the location
-we just specified in the environment variable.
+``venv`` is a tool to create isolated Python 3 environments, each with its own
+Python binary and independent set of installed Python packages in its site
+directories. Let's create one, using the location we just specified in the
+environment variable.
.. code-block:: bash
# Mac and Linux
- $ pyvenv $VENV
+ $ python3 -m venv $VENV
.. code-block:: ps1con
# Windows
- c:\> c:\Python35\python -m venv %VENV%
+ c:\> c:\Python35\python3 -m venv %VENV%
.. seealso:: See also Python 3's :mod:`venv module <python:venv>` and Python
2's `virtualenv <http://www.virtualenv.org/en/latest/>`_ package.