Skip to content

Commit b82fe4e

Browse files
authored
Merge pull request #661 from Zelgius/replace-comment
adding comment and making replace username bigger
2 parents 2cf0757 + ec878f6 commit b82fe4e

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
@@ -73,7 +73,7 @@ Open :file:`setup.py` and enter the following content. Update the package name t
7373
long_description = fh.read()
7474
7575
setuptools.setup(
76-
name="example-pkg-your-username",
76+
name="example-pkg-YOUR-USERNAME-HERE", # Replace with your own username
7777
version="0.0.1",
7878
author="Example Author",
7979
author_email="author@example.com",
@@ -207,8 +207,8 @@ files in the :file:`dist` directory:
207207
.. code-block:: text
208208
209209
dist/
210-
example_pkg_your_username-0.0.1-py3-none-any.whl
211-
example_pkg_your_username-0.0.1.tar.gz
210+
example_pkg_YOUR_USERNAME_HERE-0.0.1-py3-none-any.whl
211+
example_pkg_YOUR_USERNAME_HERE-0.0.1.tar.gz
212212
213213
.. note:: If you run into trouble here, please copy the output and file an issue
214214
over on `packaging problems`_ and we'll do our best to help you!
@@ -259,14 +259,14 @@ PyPI. After the command completes, you should see output similar to this:
259259
Uploading distributions to https://test.pypi.org/legacy/
260260
Enter your username: [your username]
261261
Enter your password:
262-
Uploading example_pkg_your_username-0.0.1-py3-none-any.whl
262+
Uploading example_pkg_YOUR_USERNAME_HERE-0.0.1-py3-none-any.whl
263263
100%|█████████████████████| 4.65k/4.65k [00:01<00:00, 2.88kB/s]
264-
Uploading example_pkg_your_username-0.0.1.tar.gz
264+
Uploading example_pkg_YOUR_USERNAME_HERE-0.0.1.tar.gz
265265
100%|█████████████████████| 4.25k/4.25k [00:01<00:00, 3.05kB/s]
266266
267267
268268
Once uploaded your package should be viewable on TestPyPI, for example,
269-
https://test.pypi.org/project/example-pkg-your-username
269+
https://test.pypi.org/project/example-pkg-YOUR-USERNAME-HERE
270270

271271

272272
Installing your newly uploaded package
@@ -278,7 +278,7 @@ detailed instructions) and install your package from TestPyPI:
278278

279279
.. code-block:: bash
280280
281-
python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps example-pkg-your-username
281+
python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps example-pkg-YOUR-USERNAME-HERE
282282
283283
Make sure to specify your username in the package name!
284284

@@ -287,10 +287,10 @@ something like this:
287287

288288
.. code-block:: text
289289
290-
Collecting example-pkg-your-username
291-
Downloading https://test-files.pythonhosted.org/packages/.../example-pkg-your-username-0.0.1-py3-none-any.whl
292-
Installing collected packages: example-pkg-your-username
293-
Successfully installed example-pkg-your-username-0.0.1
290+
Collecting example-pkg-YOUR-USERNAME-HERE
291+
Downloading https://test-files.pythonhosted.org/packages/.../example-pkg-YOUR-USERNAME-HERE-0.0.1-py3-none-any.whl
292+
Installing collected packages: example-pkg-YOUR-USERNAME-HERE
293+
Successfully installed example-pkg-YOUR-USERNAME-HERE-0.0.1
294294
295295
.. note:: This example uses ``--index-url`` flag to specify TestPyPI instead of live PyPI. Additionally, it specifies ``--no-deps``. Since TestPyPI doesn't have the same packages as the live PyPI, it's possible that attempting to install dependencies may fail or install something unexpected. While our example package doesn't have any dependencies, it's a good practice to avoid installing dependencies when using TestPyPI.
296296

@@ -305,7 +305,7 @@ Run the Python interpreter (make sure you're still in your virtualenv):
305305
306306
And then import the module and print out the ``name`` property. This should be
307307
the same regardless of what you name you gave your :term:`distribution package`
308-
in :file:`setup.py` (in this case, ``example-pkg-your-username``) because your :term:`import package` is ``example_pkg``.
308+
in :file:`setup.py` (in this case, ``example-pkg-YOUR-USERNAME-HERE``) because your :term:`import package` is ``example_pkg``.
309309

310310
.. code-block:: python
311311

0 commit comments

Comments
 (0)