summaryrefslogtreecommitdiff
path: root/docs/narr/commandline.rst
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/commandline.rst
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/commandline.rst')
-rw-r--r--docs/narr/commandline.rst26
1 files changed, 13 insertions, 13 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