Skip to content

Commit add1888

Browse files
authored
update packaging-projects.rst
- fixed the raised value and configuration errors in pyproject.toml - made explicit the creation of a LICENSE file - added TestPyPI installation example (package wasn't recognized with current's tutorial command)
1 parent 76f1b69 commit add1888

File tree

1 file changed

+10
-3
lines changed

1 file changed

+10
-3
lines changed

source/tutorials/packaging-projects.rst

Lines changed: 10 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -217,8 +217,7 @@ following this tutorial.
217217
"Programming Language :: Python :: 3",
218218
"Operating System :: OS Independent",
219219
]
220-
license = "MIT"
221-
license-files = ["LICEN[CS]E*"]
220+
license = { file = "LICENSE.md" }
222221
223222
[project.urls]
224223
Homepage = "https://github.com/pypa/sampleproject"
@@ -308,7 +307,7 @@ Creating a LICENSE
308307
It's important for every package uploaded to the Python Package Index to include
309308
a license. This tells users who install your package the terms under which they
310309
can use your package. For help picking a license, see
311-
https://choosealicense.com/. Once you have chosen a license, open
310+
https://choosealicense.com/. Once you have chosen a license, create a file called :file:`LICENSE`, open
312311
:file:`LICENSE` and enter the license text. For example, if you had chosen the
313312
MIT license:
314313

@@ -486,6 +485,14 @@ and install your package from TestPyPI:
486485
487486
python3 -m pip install --index-url https://test.pypi.org/simple/ --no-deps example-package-YOUR-USERNAME-HERE
488487
488+
489+
In case there is an issue with the above instruction and the package isn't recognized, use the link provided at TestPyPI:
490+
491+
.. code-block:: bash
492+
493+
pip install -i https://test.pypi.org/simple/ example-package-YOUR-USERNAME-HERE
494+
495+
489496
.. tab:: Windows
490497

491498
.. code-block:: bat

0 commit comments

Comments
 (0)