Use proper case for Setuptools as a library name. Change Setuptools to a gl...

Steve Piercy

2018-10-07 f868a98cdc4bec0ce10d18b66af1687f3e3a1bbb

Use proper case for Setuptools as a library name.
Change Setuptools to a glossary term where useful.

 docs/glossary.rst

@@ -43,19 +43,17 @@
     <http://svn.repoze.org>`_.  Pyramid was originally known as
     :mod:`repoze.bfg`.

   setuptools
     `Setuptools <http://peak.telecommunity.com/DevCenter/setuptools>`_
   Setuptools
     `Setuptools <https://setuptools.readthedocs.io/en/latest/>`_
     builds on Python's ``distutils`` to provide easier building,
     distribution, and installation of libraries and applications.  As of
     this writing, setuptools runs under Python 2, but not under Python 3.
     You can use :term:`distribute` under Python 3 instead.
     distribution, and installation of libraries and applications.

   distribute
     `Distribute <https://pypi.org/project/distribute/>`_ is a fork of
     :term:`setuptools` which runs on both Python 2 and Python 3.
     `Distribute <https://pypi.org/project/distribute/>`_ is a fork of :term:`Setuptools` which runs on both Python 2 and Python 3.
     It is now in legacy state because :term:`Setuptools` now runs on both Python 2 and 3.

   pkg_resources
     A module which ships with :term:`setuptools` and :term:`distribute` that
     A module which ships with :term:`Setuptools` and :term:`distribute` that
     provides an API for addressing "asset files" within a Python
     :term:`package`.  Asset files are static files, template files, etc;
     basically anything non-Python-source that lives in a Python package can
@@ -103,7 +101,7 @@
     ``easy_install``.

   entry point
     A :term:`setuptools` indirection, defined within a setuptools
     A :term:`Setuptools` indirection, defined within a Setuptools
     :term:`distribution` setup.py.  It is usually a name which refers
     to a function somewhere in a package which is held by the
     distribution.
@@ -111,7 +109,7 @@
   dotted Python name
     A reference to a Python object by name using a string, in the form
     ``path.to.modulename:attributename``.  Often used in Pyramid and
     setuptools configurations.  A variant is used in dotted names within
     Setuptools configurations.  A variant is used in dotted names within
     configurator method arguments that name objects (such as the "add_view"
     method's "view" and "context" attributes): the colon (``:``) is not
     used; in its place is a dot.
@@ -977,7 +975,7 @@
   distutils
     The standard system for packaging and distributing Python packages.  See
     https://docs.python.org/2/distutils/index.html for more information.
     :term:`setuptools` is actually an *extension* of the Distutils.
     :term:`Setuptools` is actually an *extension* of the Distutils.

   exception response
     A :term:`response` that is generated as the result of a raised exception

 docs/narr/assets.rst

@@ -735,7 +735,7 @@
- A directory of static files served up by an instance of the
  ``pyramid.static.static_view`` helper class.

- Any other asset (or set of assets) addressed by code that uses the setuptools
- Any other asset (or set of assets) addressed by code that uses the Setuptools
  :term:`pkg_resources` API.

.. index::

 docs/narr/commandline.rst

@@ -896,7 +896,7 @@
Making Your Script into a Console Script
----------------------------------------

A "console script" is :term:`setuptools` terminology for a script that gets
A "console script" is :term:`Setuptools` terminology for a script that gets
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

 docs/narr/install.rst

@@ -117,7 +117,7 @@
   ``py`` that allows users to run any installed version of Python.

.. warning:: After you install Python on Windows, you might need to add the
   directory where Python and other programs—such as pip, setuptools, and
   directory where Python and other programs—such as pip, :term:`Setuptools`, and
   cookiecutter—are installed to your environment's ``Path``. This will make it
   possible to invoke them from a command prompt.


 docs/narr/paste.rst

@@ -48,7 +48,7 @@
shorthand for a longer spelling: ``use = egg:myproject#main``.  The ``#main``
part is omitted for brevity, as ``#main`` is a default defined by PasteDeploy.
``egg:myproject#main`` is a string which has meaning to PasteDeploy.  It points
at a :term:`setuptools` :term:`entry point` named ``main`` defined in the
at a :term:`Setuptools` :term:`entry point` named ``main`` defined in the
``myproject`` project.

Take a look at the generated ``setup.py`` file for this project.

 docs/narr/project.rst

@@ -587,7 +587,7 @@
#. ``pytest.ini`` is a configuration file for running tests.

#. ``setup.py`` is the file you'll use to test and distribute your application.
   It is a standard :term:`setuptools` ``setup.py`` file.
   It is a standard :term:`Setuptools` ``setup.py`` file.

.. index::
   single: PasteDeploy
@@ -711,7 +711,7 @@
code into a version control repository, ``setup.py sdist`` places only *Python
source files* (files ending with a ``.py`` extension) into tarballs generated
by ``python setup.py sdist``.  This means, for example, if your project was not
checked into a setuptools-compatible source control system, and your project
checked into a Setuptools-compatible source control system, and your project
directory didn't contain a ``MANIFEST.in`` file that told the ``sdist``
machinery to include ``*.pt`` files, the ``myproject/templates/mytemplate.pt``
file would not be included in the generated tarball.
@@ -720,20 +720,20 @@
The ``MANIFEST.in`` file contains declarations which tell it to include files
like ``*.pt``, ``*.css`` and ``*.js`` in the generated tarball. If you include
files with extensions other than the files named in the project's
``MANIFEST.in`` and you don't make use of a setuptools-compatible version
``MANIFEST.in`` and you don't make use of a Setuptools-compatible version
control system, you'll need to edit the ``MANIFEST.in`` file and include the
statements necessary to include your new files.  See
https://docs.python.org/2/distutils/sourcedist.html#principle for more
information about how to do this.

You can also delete ``MANIFEST.in`` from your project and rely on a setuptools
You can also delete ``MANIFEST.in`` from your project and rely on a :term:`Setuptools`
feature which simply causes all files checked into a version control system to
be put into the generated tarball.  To allow this to happen, check all the
files that you'd like to be distributed along with your application's Python
files into Subversion.  After you do this, when you rerun ``setup.py sdist``,
all files checked into the version control system will be included in the
tarball.  If you don't use Subversion, and instead use a different version
control system, you may need to install a setuptools add-on such as
control system, you may need to install a :term:`Setuptools` add-on such as
``setuptools-git`` or ``setuptools-hg`` for this behavior to work properly.

.. index::
@@ -742,7 +742,7 @@
``setup.py``
~~~~~~~~~~~~

The ``setup.py`` file is a :term:`setuptools` setup file.  It is meant to be
The ``setup.py`` file is a :term:`Setuptools` setup file.  It is meant to be
used to define requirements for installing dependencies for your package and
testing, as well as distributing your application.

@@ -760,13 +760,13 @@
   :language: python
   :linenos:

The ``setup.py`` file calls the setuptools ``setup`` function, which does
The ``setup.py`` file calls the :term:`Setuptools` ``setup`` function, which does
various things depending on the arguments passed to ``pip`` on the command
line.

Within the arguments to this function call, information about your application
is kept.  While it's beyond the scope of this documentation to explain
everything about setuptools setup files, we'll provide a whirlwind tour of what
everything about :term:`Setuptools` setup files, we'll provide a whirlwind tour of what
exists in this file in this section.

Your application's name can be any string; it is specified in the ``name``

 docs/narr/scaffolding.rst

@@ -21,11 +21,11 @@

A scaffold template is just a bunch of source files and directories on disk. A
small definition class points at this directory.  It is in turn pointed at by a
:term:`setuptools` "entry point" which registers the scaffold so it can be
:term:`Setuptools` "entry point" which registers the scaffold so it can be
found by the ``pcreate`` command.

To create a scaffold template, create a Python :term:`distribution` to house
the scaffold which includes a ``setup.py`` that relies on the ``setuptools``
the scaffold which includes a ``setup.py`` that relies on the :term:`Setuptools`
package.  See `Packaging and Distributing Projects
<https://packaging.python.org/tutorials/packaging-projects/>`_ for more information
about how to do this.  For example, we'll pretend the distribution you create

 docs/quick_tour.rst

@@ -19,7 +19,7 @@
is a breeze. Unfortunately "standard" is not so simple in Python. For this
Quick Tour, it means `Python <https://www.python.org/downloads/>`_, :mod:`python:venv` (or `virtualenv for
Python 2.7 <https://virtualenv.pypa.io/en/stable/>`_),
`pip <https://pypi.org/project/pip/>`_, and `setuptools
`pip <https://pypi.org/project/pip/>`_, and `Setuptools
<https://pypi.org/project/setuptools/>`_.

To save a little bit of typing and to be certain that we use the modules,

 docs/quick_tutorial/ini.rst

@@ -13,7 +13,7 @@

Pyramid has a first-class concept of :ref:`configuration <configuration_narr>` distinct from code.
This approach is optional, but its presence makes it distinct from other Python web frameworks.
It taps into Python's Setuptools library, which establishes conventions for installing and providing ":term:`entry point`\ s" for Python projects.
It taps into Python's :term:`Setuptools` library, which establishes conventions for installing and providing ":term:`entry point`\ s" for Python projects.
Pyramid uses an :term:`entry point` to let a Pyramid application know where to find the WSGI app.


@@ -38,7 +38,7 @@

       cd ..; cp -r package ini; cd ini

#. Our ``ini/setup.py`` needs a setuptools :term:`entry point` in the ``setup()`` function:
#. Our ``ini/setup.py`` needs a :term:`Setuptools` :term:`entry point` in the ``setup()`` function:

   .. literalinclude:: ini/setup.py
       :linenos:

 docs/tutorials/wiki/basiclayout.rst

@@ -21,7 +21,7 @@

When you run the application using the ``pserve`` command using the
``development.ini`` generated configuration file, the application
configuration points at a setuptools *entry point* described as
configuration points at a :term:`Setuptools` :term:`entry point` described as
``egg:tutorial``.  In our application, because the application's ``setup.py``
file says so, this entry point happens to be the ``main`` function within the
file named ``__init__.py``.