summaryrefslogtreecommitdiff
path: root/docs/narr
diff options
context:
space:
mode:
authorSteve Piercy <web@stevepiercy.com>2016-04-12 06:43:38 -0700
committerSteve Piercy <web@stevepiercy.com>2016-04-12 06:43:38 -0700
commitd67566acebf890a603fad0e9069d5e131dfb5b31 (patch)
tree78e5994d2119b45461ea7c1ba924b8d000d7ac62 /docs/narr
parent654821decedd4f70e6de22e177b216f18524e609 (diff)
downloadpyramid-d67566acebf890a603fad0e9069d5e131dfb5b31.tar.gz
pyramid-d67566acebf890a603fad0e9069d5e131dfb5b31.tar.bz2
pyramid-d67566acebf890a603fad0e9069d5e131dfb5b31.zip
one does not simply "create a virtualenv". one should "create a virtual environment".
- Fixes #2483
Diffstat (limited to 'docs/narr')
-rw-r--r--docs/narr/commandline.rst26
-rw-r--r--docs/narr/i18n.rst10
-rw-r--r--docs/narr/install.rst4
-rw-r--r--docs/narr/project.rst36
4 files changed, 38 insertions, 38 deletions
diff --git a/docs/narr/commandline.rst b/docs/narr/commandline.rst
index 7f112550f..6cd90d42f 100644
--- a/docs/narr/commandline.rst
+++ b/docs/narr/commandline.rst
@@ -815,17 +815,17 @@ Making Your Script into a Console Script
----------------------------------------
A "console script" is :term:`setuptools` terminology for a script that gets
-installed into the ``bin`` directory of a Python :term:`virtualenv` (or "base"
-Python environment) when a :term:`distribution` which houses that script is
-installed. Because it's installed into the ``bin`` directory of a virtualenv
-when the distribution is installed, it's a convenient way to package and
-distribute functionality that you can call from the command-line. It's often
-more convenient to create a console script than it is to create a ``.py``
-script and instruct people to call it with the "right" Python interpreter. A
-console script generates a file that lives in ``bin``, and when it's invoked it
-will always use the "right" Python environment, which means it will always be
-invoked in an environment where all the libraries it needs (such as Pyramid)
-are available.
+installed into the ``bin`` directory of a Python :term:`virtual environment`
+(or "base" Python environment) when a :term:`distribution` which houses that
+script is installed. Because it's installed into the ``bin`` directory of a
+virtual environment when the distribution is installed, it's a convenient way
+to package and distribute functionality that you can call from the
+command-line. It's often more convenient to create a console script than it is
+to create a ``.py`` script and instruct people to call it with the "right"
+Python interpreter. A console script generates a file that lives in ``bin``,
+and when it's invoked it will always use the "right" Python environment, which
+means it will always be invoked in an environment where all the libraries it
+needs (such as Pyramid) are available.
In general, you can make your script into a console script by doing the
following:
@@ -843,7 +843,7 @@ following:
- Run ``pip install -e .`` or ``pip install .`` to get your distribution
reinstalled. When you reinstall your distribution, a file representing the
script that you named in the last step will be in the ``bin`` directory of
- the virtualenv in which you installed the distribution. It will be
+ the virtual environment in which you installed the distribution. It will be
executable. Invoking it from a terminal will execute your callable.
As an example, let's create some code that can be invoked by a console script
@@ -1029,7 +1029,7 @@ The result will be something like:
)
Once you've done this, invoking ``$VENV/bin/pip install -e .`` will install a
-file named ``show_settings`` into the ``$somevirtualenv/bin`` directory with a
+file named ``show_settings`` into the ``$somevenv/bin`` directory with a
small bit of Python code that points to your entry point. It will be
executable. Running it without any arguments will print an error and exit.
Running it with a single argument that is the path of a config file will print
diff --git a/docs/narr/i18n.rst b/docs/narr/i18n.rst
index b385eaf96..93e355ffe 100644
--- a/docs/narr/i18n.rst
+++ b/docs/narr/i18n.rst
@@ -270,12 +270,12 @@ system run this command:
$ sudo apt-get install gettext
Installing Lingua is done with the Python packaging tools. If the
-:term:`virtualenv` into which you've installed your :app:`Pyramid` application
-lives in ``/my/virtualenv``, you can install Lingua like so:
+:term:`virtual environment` into which you've installed your :app:`Pyramid`
+application lives in ``/my/venv``, you can install Lingua like so:
.. code-block:: text
- $ cd /my/virtualenv
+ $ cd /my/venv
$ $VENV/bin/easy_install lingua
Installation on Windows
@@ -288,8 +288,8 @@ compile it yourself. Make sure the installation path is added to your
``$PATH``.
Installing Lingua is done with the Python packaging tools. If the
-:term:`virtualenv` into which you've installed your :app:`Pyramid` application
-lives in ``C:\my\virtualenv``, you can install Lingua like so:
+:term:`virtual environment` into which you've installed your :app:`Pyramid`
+application lives in ``C:\my\venv``, you can install Lingua like so:
.. code-block:: text
diff --git a/docs/narr/install.rst b/docs/narr/install.rst
index 548d040f1..7cd47d681 100644
--- a/docs/narr/install.rst
+++ b/docs/narr/install.rst
@@ -150,7 +150,7 @@ After installing Python as described previously in :ref:`for-mac-os-x-users` or
:ref:`if-you-don-t-yet-have-a-python-interpreter-unix`, and satisfying the
:ref:`requirements-for-installing-packages`, you can now install Pyramid.
-#. Make a :term:`virtualenv` workspace:
+#. Make a :term:`virtual environment` workspace:
.. code-block:: bash
@@ -184,7 +184,7 @@ After installing Python as described previously in
:ref:`if-you-don-t-yet-have-a-python-interpreter-windows`, and satisfying the
:ref:`requirements-for-installing-packages`, you can now install Pyramid.
-#. Make a :term:`virtualenv` workspace:
+#. Make a :term:`virtual environment` workspace:
.. code-block:: ps1con
diff --git a/docs/narr/project.rst b/docs/narr/project.rst
index 355a42d8a..24e484c11 100644
--- a/docs/narr/project.rst
+++ b/docs/narr/project.rst
@@ -67,14 +67,14 @@ Creating the Project
.. seealso:: See also the output of :ref:`pcreate --help <pcreate_script>`.
In :ref:`installing_chapter`, you created a virtual Python environment via the
-``virtualenv`` command. To start a :app:`Pyramid` :term:`project`, use the
-``pcreate`` command installed within the virtualenv. We'll choose the
+``venv`` command. To start a :app:`Pyramid` :term:`project`, use the
+``pcreate`` command installed within the virtual environment. We'll choose the
``starter`` scaffold for this purpose. When we invoke ``pcreate``, it will
create a directory that represents our project.
-In :ref:`installing_chapter` we called the virtualenv directory ``env``. The
-following commands assume that our current working directory is the ``env``
-directory.
+In :ref:`installing_chapter` we called the virtual environment directory
+``env``. The following commands assume that our current working directory is
+the ``env`` directory.
The below example uses the ``pcreate`` command to create a project with the
``starter`` scaffold.
@@ -112,16 +112,16 @@ The ``MyProject`` project directory contains an additional subdirectory named
which holds very simple :app:`Pyramid` sample code. This is where you'll edit
your application's Python code and templates.
-We created this project within an ``env`` virtualenv directory. However, note
-that this is not mandatory. The project directory can go more or less anywhere
-on your filesystem. You don't need to put it in a special "web server"
-directory, and you don't need to put it within a virtualenv directory. The
-author uses Linux mainly, and tends to put project directories which he creates
-within his ``~/projects`` directory. On Windows, it's a good idea to put
-project directories within a directory that contains no space characters, so
-it's wise to *avoid* a path that contains, i.e., ``My Documents``. As a
-result, the author, when he uses Windows, just puts his projects in
-``C:\projects``.
+We created this project within an ``env`` virtual environment directory.
+However, note that this is not mandatory. The project directory can go more or
+less anywhere on your filesystem. You don't need to put it in a special "web
+server" directory, and you don't need to put it within a virtual environment
+directory. The author uses Linux mainly, and tends to put project directories
+which he creates within his ``~/projects`` directory. On Windows, it's a good
+idea to put project directories within a directory that contains no space
+characters, so it's wise to *avoid* a path that contains, i.e., ``My
+Documents``. As a result, the author, when he uses Windows, just puts his
+projects in ``C:\projects``.
.. warning::
@@ -140,9 +140,9 @@ Installing your Newly Created Project for Development
To install a newly created project for development, you should ``cd`` to the
newly created project directory and use the Python interpreter from the
-:term:`virtualenv` you created during :ref:`installing_chapter` to invoke the
-command ``pip install -e .``, which installs the project in development mode
-(``-e`` is for "editable") into the current directory (``.``).
+:term:`virtual environment` you created during :ref:`installing_chapter` to
+invoke the command ``pip install -e .``, which installs the project in
+development mode (``-e`` is for "editable") into the current directory (``.``).
The file named ``setup.py`` will be in the root of the pcreate-generated
project directory. The ``python`` you're invoking should be the one that lives