diff options
| author | Steve Piercy <web@stevepiercy.com> | 2018-10-07 02:40:23 -0700 |
|---|---|---|
| committer | Steve Piercy <web@stevepiercy.com> | 2018-10-07 04:26:35 -0700 |
| commit | 315e469540afeba4bffe7bafb1364a7bab059a24 (patch) | |
| tree | 56f1ccbc94a9e7974eb302755cfca6251553ff4b /docs/narr | |
| parent | 50b8b42b7da17d20534e5fd21905c8fe56b68069 (diff) | |
| download | pyramid-315e469540afeba4bffe7bafb1364a7bab059a24.tar.gz pyramid-315e469540afeba4bffe7bafb1364a7bab059a24.tar.bz2 pyramid-315e469540afeba4bffe7bafb1364a7bab059a24.zip | |
Use proper case for Setuptools as a library name.
Change Setuptools to a glossary term where useful.
Diffstat (limited to 'docs/narr')
| -rw-r--r-- | docs/narr/assets.rst | 2 | ||||
| -rw-r--r-- | docs/narr/commandline.rst | 2 | ||||
| -rw-r--r-- | docs/narr/install.rst | 2 | ||||
| -rw-r--r-- | docs/narr/paste.rst | 2 | ||||
| -rw-r--r-- | docs/narr/project.rst | 16 | ||||
| -rw-r--r-- | docs/narr/scaffolding.rst | 4 |
6 files changed, 14 insertions, 14 deletions
diff --git a/docs/narr/assets.rst b/docs/narr/assets.rst index 06594dbb7..d1d64f0c3 100644 --- a/docs/narr/assets.rst +++ b/docs/narr/assets.rst @@ -735,7 +735,7 @@ feature, a :term:`Configurator` API exists named - 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:: diff --git a/docs/narr/commandline.rst b/docs/narr/commandline.rst index f8ca8366b..7af6bba43 100644 --- a/docs/narr/commandline.rst +++ b/docs/narr/commandline.rst @@ -896,7 +896,7 @@ See :ref:`logging_chapter` for more information on logging within 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 diff --git a/docs/narr/install.rst b/docs/narr/install.rst index dbf5dc2eb..248b432d3 100644 --- a/docs/narr/install.rst +++ b/docs/narr/install.rst @@ -117,7 +117,7 @@ following options: ``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. diff --git a/docs/narr/paste.rst b/docs/narr/paste.rst index 8a0d505b3..ac8f7fdca 100644 --- a/docs/narr/paste.rst +++ b/docs/narr/paste.rst @@ -48,7 +48,7 @@ The line in ``[app:main]`` above that says ``use = egg:myproject`` is actually 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. diff --git a/docs/narr/project.rst b/docs/narr/project.rst index 84fd8e31f..725263407 100644 --- a/docs/narr/project.rst +++ b/docs/narr/project.rst @@ -587,7 +587,7 @@ describe, run, and test your application. #. ``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 @@ Without the presence of a ``MANIFEST.in`` file or without checking your source 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 @@ Projects generated by Pyramid cookiecutters include a default ``MANIFEST.in`` fi 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 @@ control system, you may need to install a setuptools add-on such as ``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 @@ Our generated ``setup.py`` looks like this: :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`` diff --git a/docs/narr/scaffolding.rst b/docs/narr/scaffolding.rst index 083d831cc..47eb2c658 100644 --- a/docs/narr/scaffolding.rst +++ b/docs/narr/scaffolding.rst @@ -21,11 +21,11 @@ Basics 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 |
