Skip to content

Commit 52c1338

Browse files
authored
Merge pull request #893 from bhrutledge/866-lowercase-terms
Packaging Python Projects: Normalize terms to lowercase
2 parents c7efa41 + 55cbe0d commit 52c1338

1 file changed

Lines changed: 21 additions & 20 deletions

File tree

source/tutorials/packaging-projects.rst

Lines changed: 21 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -191,12 +191,12 @@ an escape hatch when absolutely necessary.
191191
the project that contains all Python source files for the package --- so
192192
in this case the ``src`` directory is designated the root package.
193193
- ``packages`` is a list of all Python :term:`import packages <Import
194-
Package>` that should be included in the :term:`Distribution Package`.
195-
Instead of listing each package manually, we can use the ``find:`` directive
196-
to automatically discover all packages and subpackages and
197-
``options.packages.find`` to specify the ``package_dir`` to use. In this
198-
case, the list of packages will be ``example_pkg`` as that's the only
199-
package present.
194+
Package>` that should be included in the :term:`distribution package
195+
<Distribution Package>`. Instead of listing each package manually, we can
196+
use the ``find:`` directive to automatically discover all packages and
197+
subpackages and ``options.packages.find`` to specify the ``package_dir``
198+
to use. In this case, the list of packages will be ``example_pkg`` as
199+
that's the only package present.
200200
- ``python_requires`` gives the versions of Python supported by your
201201
project. Installers like pip will look back though older versions of
202202
packages until it finds one that has a matching Python version.
@@ -304,11 +304,11 @@ an escape hatch when absolutely necessary.
304304
package --- so in this case the ``src`` directory is designated the root
305305
package.
306306
- ``packages`` is a list of all Python :term:`import packages <Import
307-
Package>` that should be included in the :term:`Distribution Package`.
308-
Instead of listing each package manually, we can use :func:`find_packages`
309-
to automatically discover all packages and subpackages under ``package_dir``.
310-
In this case, the list of packages will be ``example_pkg`` as that's the
311-
only package present.
307+
Package>` that should be included in the :term:`distribution package
308+
<Distribution Package>`. Instead of listing each package manually, we can
309+
use :func:`find_packages` to automatically discover all packages and
310+
subpackages under ``package_dir``. In this case, the list of packages will
311+
be ``example_pkg`` as that's the only package present.
312312
- ``python_requires`` gives the versions of Python supported by your
313313
project. Installers like pip will look back though older versions of
314314
packages until it finds one that has a matching Python version.
@@ -439,12 +439,13 @@ files in the :file:`dist` directory:
439439
https://github.com/pypa/packaging-problems/issues/new?title=Trouble+following+packaging+libraries+tutorial
440440

441441

442-
The ``tar.gz`` file is a :term:`Source Archive` whereas the ``.whl`` file is a
443-
:term:`Built Distribution`. Newer :ref:`pip` versions preferentially install
444-
built distributions, but will fall back to source archives if needed. You
445-
should always upload a source archive and provide built archives for the
446-
platforms your project is compatible with. In this case, our example package is
447-
compatible with Python on any platform so only one built distribution is needed.
442+
The ``tar.gz`` file is a :term:`source archive <Source Archive>` whereas the
443+
``.whl`` file is a :term:`built distribution <Built Distribution>`. Newer
444+
:ref:`pip` versions preferentially install built distributions, but will fall
445+
back to source archives if needed. You should always upload a source archive and
446+
provide built archives for the platforms your project is compatible with. In
447+
this case, our example package is compatible with Python on any platform so only
448+
one built distribution is needed.
448449

449450
Uploading the distribution archives
450451
-----------------------------------
@@ -576,9 +577,9 @@ and from the interpreter shell import the package:
576577
577578
>>> import example_pkg
578579
579-
Note that the :term:`Import Package` is ``example_pkg`` regardless of what
580-
name you gave your :term:`Distribution Package`
581-
in :file:`setup.py` (in this case, ``example-pkg-YOUR-USERNAME-HERE``).
580+
Note that the :term:`import package <Import Package>` is ``example_pkg``
581+
regardless of what name you gave your :term:`distribution package <Distribution
582+
Package>` in :file:`setup.py` (in this case, ``example-pkg-YOUR-USERNAME-HERE``).
582583

583584
Next steps
584585
----------

0 commit comments

Comments
 (0)