Skip to content

Commit 57e7d5c

Browse files
committed
Don't abbreviate package name
1 parent 7866cb6 commit 57e7d5c

1 file changed

Lines changed: 12 additions & 12 deletions

File tree

source/tutorials/packaging-projects.rst

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ sure you have the latest version installed:
2424
A simple project
2525
----------------
2626

27-
This tutorial uses a simple project named ``example_pkg``. We recommend
27+
This tutorial uses a simple project named ``example_package``. We recommend
2828
following this tutorial as-is using this project, before packaging your own
2929
project.
3030

@@ -34,10 +34,10 @@ Create the following file structure locally:
3434
3535
packaging_tutorial/
3636
└── src/
37-
└── example_pkg/
37+
└── example_package/
3838
└── __init__.py
3939
40-
:file:`src/example_pkg/__init__.py` is required to import the directory as a
40+
:file:`src/example_package/__init__.py` is required to import the directory as a
4141
package, and should be empty. If you are unfamiliar with Python's modules and
4242
:term:`import packages <Import Package>`, take a few minutes to read over the
4343
`Python documentation for packages and modules`_.
@@ -63,7 +63,7 @@ When you're done, the project structure will look like this:
6363
├── README.md
6464
├── setup.cfg
6565
├── src/
66-
│   └── example_pkg/
66+
│   └── example_package/
6767
│   └── __init__.py
6868
└── tests/
6969
@@ -206,7 +206,7 @@ be required, but can be omitted with newer versions of setuptools and pip.
206206
<Distribution Package>`. Instead of listing each package manually, we can
207207
use the ``find:`` directive to automatically discover all packages and
208208
subpackages and ``options.packages.find`` to specify the ``package_dir``
209-
to use. In this case, the list of packages will be ``example_pkg`` as
209+
to use. In this case, the list of packages will be ``example_package`` as
210210
that's the only package present.
211211
- ``python_requires`` gives the versions of Python supported by your
212212
project. Installers like :ref:`pip` will look back though older versions of
@@ -298,7 +298,7 @@ be required, but can be omitted with newer versions of setuptools and pip.
298298
<Distribution Package>`. Instead of listing each package manually, we can
299299
use :func:`find_packages` to automatically discover all packages and
300300
subpackages under ``package_dir``. In this case, the list of packages will
301-
be ``example_pkg`` as that's the only package present.
301+
be ``example_package`` as that's the only package present.
302302
- ``python_requires`` gives the versions of Python supported by your
303303
project. Installers like :ref:`pip` will look back though older versions of
304304
packages until it finds one that has a matching Python version.
@@ -419,8 +419,8 @@ files in the :file:`dist` directory:
419419
.. code-block:: text
420420
421421
dist/
422-
example_pkg_YOUR_USERNAME_HERE-0.0.1-py3-none-any.whl
423-
example_pkg_YOUR_USERNAME_HERE-0.0.1.tar.gz
422+
example_package_YOUR_USERNAME_HERE-0.0.1-py3-none-any.whl
423+
example_package_YOUR_USERNAME_HERE-0.0.1.tar.gz
424424
425425
.. note:: If you run into trouble here, please copy the output and file an issue
426426
over on `packaging problems`_ and we'll do our best to help you!
@@ -497,9 +497,9 @@ After the command completes, you should see output similar to this:
497497
Uploading distributions to https://test.pypi.org/legacy/
498498
Enter your username: [your username]
499499
Enter your password:
500-
Uploading example_pkg_YOUR_USERNAME_HERE-0.0.1-py3-none-any.whl
500+
Uploading example_package_YOUR_USERNAME_HERE-0.0.1-py3-none-any.whl
501501
100%|█████████████████████| 4.65k/4.65k [00:01<00:00, 2.88kB/s]
502-
Uploading example_pkg_YOUR_USERNAME_HERE-0.0.1.tar.gz
502+
Uploading example_package_YOUR_USERNAME_HERE-0.0.1.tar.gz
503503
100%|█████████████████████| 4.25k/4.25k [00:01<00:00, 3.05kB/s]
504504
505505
@@ -564,9 +564,9 @@ and import the package:
564564

565565
.. code-block:: python
566566
567-
>>> import example_pkg
567+
>>> import example_package
568568
569-
Note that the :term:`import package <Import Package>` is ``example_pkg``
569+
Note that the :term:`import package <Import Package>` is ``example_package``
570570
regardless of what ``name`` you gave your :term:`distribution package <Distribution
571571
Package>` in :file:`setup.cfg` or :file:`setup.py` (in this case,
572572
``example-pkg-YOUR-USERNAME-HERE``).

0 commit comments

Comments
 (0)