Skip to content

Commit

Permalink
Declare license file in packaging tutorial (#1098)
Browse files Browse the repository at this point in the history
* 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 <brian@bhrutledge.com>
  • Loading branch information
EpicWink and bhrutledge committed Jun 28, 2022
1 parent 3f972e3 commit 813584b
Showing 1 changed file with 2 additions and 0 deletions.
2 changes: 2 additions & 0 deletions source/tutorials/packaging-projects.rst
Original file line number Diff line number Diff line change
Expand Up @@ -188,6 +188,7 @@ following this tutorial.
]
description = "A small example package"
readme = "README.md"
license = { file="LICENSE" }
requires-python = ">=3.7"
classifiers = [
"Programming Language :: Python :: 3",
Expand Down Expand Up @@ -216,6 +217,7 @@ following this tutorial.
In this case, the description is loaded from :file:`README.md` (which is a
common pattern). There also is a more advanced table form described in the
:ref:`project metadata specification <declaring-project-metadata>`.
- ``license`` is the path to the :file:`LICENSE` file, described below.
- ``requires-python`` gives the versions of Python supported by your
project. Installers like :ref:`pip` will look back through older versions of
packages until it finds one that has a matching Python version.
Expand Down

0 comments on commit 813584b

Please sign in to comment.