summaryrefslogtreecommitdiff
path: root/docs/glossary.rst
diff options
context:
space:
mode:
authorMichael Merickel <mmerickel@users.noreply.github.com>2016-04-12 17:56:53 -0500
committerMichael Merickel <mmerickel@users.noreply.github.com>2016-04-12 17:56:53 -0500
commit73cd1e62745fddee602e95837f155ffd499e51b7 (patch)
tree462e7bec14ef3f5531837f9ab7d1bfd2a3f4d797 /docs/glossary.rst
parentfa43952e617ad68c52447da28fc7f5be23ff4b10 (diff)
parent39d7c8bb68a94cf29256ba5da463da0432b0233c (diff)
downloadpyramid-73cd1e62745fddee602e95837f155ffd499e51b7.tar.gz
pyramid-73cd1e62745fddee602e95837f155ffd499e51b7.tar.bz2
pyramid-73cd1e62745fddee602e95837f155ffd499e51b7.zip
Merge pull request #2468 from Pylons/docs/easy-install-to-pip.2104
Docs: easy install to pip
Diffstat (limited to 'docs/glossary.rst')
-rw-r--r--docs/glossary.rst34
1 files changed, 29 insertions, 5 deletions
diff --git a/docs/glossary.rst b/docs/glossary.rst
index 039665926..655301a5c 100644
--- a/docs/glossary.rst
+++ b/docs/glossary.rst
@@ -155,9 +155,9 @@ Glossary
request before it returns a :term:`context` resource.
virtualenv
- A term referring both to an isolated Python environment,
- or `the leading tool <http://www.virtualenv.org>`_ that allows one to
- create such environments.
+ The `virtualenv tool <https://virtualenv.pypa.io/en/latest/>`_ that allows
+ one to create virtual environments. In Python 3.3 and greater,
+ :term:`venv` is the preferred tool.
Note: whenever you encounter commands prefixed with ``$VENV`` (Unix)
or ``%VENV`` (Windows), know that that is the environment variable whose
@@ -1012,8 +1012,8 @@ Glossary
console script
A script written to the ``bin`` (on UNIX, or ``Scripts`` on Windows)
- directory of a Python installation or :term:`virtualenv` as the result of
- running ``setup.py install`` or ``setup.py develop``.
+ directory of a Python installation or :term:`virtual environment` as the
+ result of running ``pip install`` or ``pip install -e .``.
introspector
An object with the methods described by
@@ -1098,3 +1098,27 @@ Glossary
implementing the :class:`pyramid.interfaces.IViewDeriver` interface.
Examples of built-in derivers including view mapper, the permission
checker, and applying a renderer to a dictionary returned from the view.
+
+ pip
+ The `Python Packaging Authority's <https://www.pypa.io/>`_ recommended
+ tool for installing Python packages.
+
+ pyvenv
+ 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`` on UNIX or
+ ``python -m venv`` on Windows, which is backward compatible on Python
+ 3.3 and greater.
+
+ virtual environment
+ An isolated Python environment that allows packages to be installed for
+ use by a particular application, rather than being installed system wide.
+
+ venv
+ The `Python Packaging Authority's <https://www.pypa.io/>`_ recommended
+ tool for creating virtual environments on Python 3.3 and greater.
+
+ Note: whenever you encounter commands prefixed with ``$VENV`` (Unix)
+ or ``%VENV`` (Windows), know that that is the environment variable whose
+ value is the root of the virtual environment in question.