Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add support for license.text #716

Closed
wants to merge 1 commit into from
Closed

Conversation

cdce8p
Copy link
Contributor

@cdce8p cdce8p commented Feb 8, 2025

Before license expressions, the license table was allowed to contain a text key. That never got implemented even though the docs list it as supported. Map license.text to the License core metadata field.

license
A valid SPDX `license expression <https://peps.python.org/pep-0639/#term-license-expression>`_
or a table with either a ``file`` key (a relative path to a license file) or a
``text`` key (the license text).

It seems this was accidentally removed in f08bb9f

Co-authored-by: Thomas Kluyver <[email protected]>
@takluyver
Copy link
Member

Thanks, but I actually took it back out deliberately. It was never clear to me whether the project.license.text field was meant to contain a license name or the full text of the license, and I didn't want to mess up the metadata with the full text, especially since it wasn't really used for anything. Before the license expressions, the classifiers were the best way to add vaguely structured info about licenses. And it seems a bit weird to start adding that in just when it's deprecated.

Sorry not to be clearer about that and leave you redoing the change!

@takluyver takluyver closed this Feb 8, 2025
@cdce8p
Copy link
Contributor Author

cdce8p commented Feb 8, 2025

It was never clear to me whether the project.license.text field was meant to contain a license name or the full text of the license, and I didn't want to mess up the metadata with the full text, especially since it wasn't really used for anything.

Yeah, I agree that it was kind of confusing. The best way I've seen it used is actually with a SPDX license identifier itself, before just project.license was allowed / supported. Since the License metadata field is actually displayed on PyPI as well, that was quite useful.

Not really necessary now that license expressions will be officially supported.

@cdce8p cdce8p deleted the license-text branch February 8, 2025 11:45
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants