@@ -158,7 +158,7 @@ be required, but can be omitted with newer versions of setuptools and pip.
158158 .. code-block :: python
159159
160160 [metadata]
161- name = example- pkg - YOUR - USERNAME - HERE
161+ name = example- package - YOUR - USERNAME - HERE
162162 version = 0.0 .1
163163 author = Example Author
164164 author_email = author@ example.com
@@ -258,7 +258,7 @@ be required, but can be omitted with newer versions of setuptools and pip.
258258 long_description = fh.read()
259259
260260 setuptools.setup(
261- name = " example-pkg -YOUR-USERNAME-HERE" ,
261+ name = " example-package -YOUR-USERNAME-HERE" ,
262262 version = " 0.0.1" ,
263263 author = " Example Author" ,
264264@@ -452,8 +452,8 @@ files in the :file:`dist` directory:
452452.. code-block :: text
453453
454454 dist/
455- example_package_YOUR_USERNAME_HERE -0.0.1-py3-none-any.whl
456- example_package_YOUR_USERNAME_HERE -0.0.1.tar.gz
455+ example-package-YOUR-USERNAME-HERE -0.0.1-py3-none-any.whl
456+ example-package-YOUR-USERNAME-HERE -0.0.1.tar.gz
457457
458458
459459 The ``tar.gz `` file is a :term: `source archive <Source Archive> ` whereas the
@@ -524,14 +524,14 @@ After the command completes, you should see output similar to this:
524524 Uploading distributions to https://test.pypi.org/legacy/
525525 Enter your username: [your username]
526526 Enter your password:
527- Uploading example_package_YOUR_USERNAME_HERE -0.0.1-py3-none-any.whl
527+ Uploading example-package-YOUR-USERNAME-HERE -0.0.1-py3-none-any.whl
528528 100%| █████████████████████| 4.65k/4.65k [00:01< 00:00, 2.88kB/s]
529- Uploading example_package_YOUR_USERNAME_HERE -0.0.1.tar.gz
529+ Uploading example-package-YOUR-USERNAME-HERE -0.0.1.tar.gz
530530 100%| █████████████████████| 4.25k/4.25k [00:01< 00:00, 3.05kB/s]
531531
532532
533533 Once uploaded your package should be viewable on TestPyPI, for example,
534- https://test.pypi.org/project/example-pkg -YOUR-USERNAME-HERE
534+ https://test.pypi.org/project/example-package -YOUR-USERNAME-HERE
535535
536536
537537Installing your newly uploaded package
@@ -545,13 +545,13 @@ and install your package from TestPyPI:
545545
546546 .. code-block :: bash
547547
548- python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps example-pkg -YOUR-USERNAME-HERE
548+ python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps example-package -YOUR-USERNAME-HERE
549549
550550 .. tab :: Windows
551551
552552 .. code-block :: bat
553553
554- py -m pip install --index-url https://test.pypi.org/simple/ --no-deps example-pkg -YOUR-USERNAME-HERE
554+ py -m pip install --index-url https://test.pypi.org/simple/ --no-deps example-package -YOUR-USERNAME-HERE
555555
556556 Make sure to specify your username in the package name!
557557
@@ -560,10 +560,10 @@ something like this:
560560
561561.. code-block :: text
562562
563- Collecting example-pkg -YOUR-USERNAME-HERE
564- Downloading https://test-files.pythonhosted.org/packages/.../example-pkg -YOUR-USERNAME-HERE-0.0.1-py3-none-any.whl
565- Installing collected packages: example-pkg -YOUR-USERNAME-HERE
566- Successfully installed example-pkg -YOUR-USERNAME-HERE-0.0.1
563+ Collecting example-package -YOUR-USERNAME-HERE
564+ Downloading https://test-files.pythonhosted.org/packages/.../example-package -YOUR-USERNAME-HERE-0.0.1-py3-none-any.whl
565+ Installing collected packages: example-package -YOUR-USERNAME-HERE
566+ Successfully installed example-package -YOUR-USERNAME-HERE-0.0.1
567567
568568 .. note :: This example uses ``--index-url`` flag to specify TestPyPI instead of
569569 live PyPI. Additionally, it specifies ``--no-deps ``. Since TestPyPI doesn't
@@ -598,7 +598,7 @@ and import the package:
598598 Note that the :term: `import package <Import Package> ` is ``example_package ``
599599regardless of what ``name `` you gave your :term: `distribution package <Distribution
600600Package> ` in :file: `setup.cfg ` or :file: `setup.py ` (in this case,
601- ``example-pkg -YOUR-USERNAME-HERE ``).
601+ ``example-package -YOUR-USERNAME-HERE ``).
602602
603603Next steps
604604----------
0 commit comments