Skip to content

Commit 813584b

Browse files
EpicWinkbhrutledge
andauthored
Declare license file in packaging tutorial (#1098)
* Declare license file in packaging tutorial Set and document `license.file` in project metadata in the packaging tutorial Fixes #1097 * Fix license doc in packaging tutorial * Update source/tutorials/packaging-projects.rst Co-authored-by: Brian Rutledge <[email protected]>
1 parent 3f972e3 commit 813584b

File tree

1 file changed

+2
-0
lines changed

1 file changed

+2
-0
lines changed

source/tutorials/packaging-projects.rst

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -188,6 +188,7 @@ following this tutorial.
188188
]
189189
description = "A small example package"
190190
readme = "README.md"
191+
license = { file="LICENSE" }
191192
requires-python = ">=3.7"
192193
classifiers = [
193194
"Programming Language :: Python :: 3",
@@ -216,6 +217,7 @@ following this tutorial.
216217
In this case, the description is loaded from :file:`README.md` (which is a
217218
common pattern). There also is a more advanced table form described in the
218219
:ref:`project metadata specification <declaring-project-metadata>`.
220+
- ``license`` is the path to the :file:`LICENSE` file, described below.
219221
- ``requires-python`` gives the versions of Python supported by your
220222
project. Installers like :ref:`pip` will look back through older versions of
221223
packages until it finds one that has a matching Python version.

0 commit comments

Comments
 (0)