Skip to content

Commit 8f9a156

Browse files
authored
Merge pull request #892 from bhrutledge/866-package-name
Packaging Python Projects: Tweak package naming suggestions
2 parents 52c1338 + 9f9b824 commit 8f9a156

1 file changed

Lines changed: 9 additions & 10 deletions

File tree

source/tutorials/packaging-projects.rst

Lines changed: 9 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -116,15 +116,14 @@ an escape hatch when absolutely necessary.
116116
code files to include. Eventually much of this configuration may be able to move
117117
to :file:`pyproject.toml`.
118118

119-
Open :file:`setup.cfg` and enter the following content. Update the package name
120-
to include your username (for example, ``example-pkg-theacodes``), this ensures
121-
that you have a unique package name and that your package doesn't conflict with
122-
packages uploaded by other people following this tutorial.
119+
Open :file:`setup.cfg` and enter the following content. Change the ``name``
120+
to include your username; this ensures that you have a unique package name
121+
and that your package doesn't conflict with packages uploaded by other
122+
people following this tutorial.
123123

124124
.. code-block:: python
125125
126126
[metadata]
127-
# replace with your username:
128127
name = example-pkg-YOUR-USERNAME-HERE
129128
version = 0.0.1
130129
author = Example Author
@@ -232,10 +231,10 @@ an escape hatch when absolutely necessary.
232231
about your package (such as the name and version) as well as which code files
233232
to include.
234233

235-
Open :file:`setup.py` and enter the following content. Update the package name
236-
to include your username (for example, ``example-pkg-theacodes``), this ensures
237-
that you have a unique package name and that your package doesn't conflict with
238-
packages uploaded by other people following this tutorial.
234+
Open :file:`setup.py` and enter the following content. Change the ``name``
235+
to include your username; this ensures that you have a unique package name
236+
and that your package doesn't conflict with packages uploaded by other
237+
people following this tutorial.
239238

240239
.. code-block:: python
241240
@@ -245,7 +244,7 @@ an escape hatch when absolutely necessary.
245244
long_description = fh.read()
246245
247246
setuptools.setup(
248-
name="example-pkg-YOUR-USERNAME-HERE", # Replace with your own username
247+
name="example-pkg-YOUR-USERNAME-HERE",
249248
version="0.0.1",
250249
author="Example Author",
251250
author_email="author@example.com",

0 commit comments

Comments
 (0)