-
Notifications
You must be signed in to change notification settings - Fork 1.3k
Clarify throughout the docs that the license
key in pyproject.toml
is for the distribution
#1909
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
base: main
Are you sure you want to change the base?
Conversation
…` is for the distribution
The link failure is unrelated: https://github.com/pypa/packaging.python.org/actions/runs/17625533614/job/50081389316?pr=1909#step:5:1051 |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
This is the clarification agreed upon.
you want to allow users a choice of multiple licenses). You can use | ||
parenthesis (``()``) for grouping to form expressions that cover even the most | ||
complex situations. | ||
In short, ``License-1 AND License-2`` mean that *both* licenses apply, or parts |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
"or parts of it" no longer makes sense here after you removed "your project".
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
I think this is correct after reviewing the glossary with definitions, but I'm not 100% sure. "Distribution Archive" refers to "Distribution Package" which doesn't mention sdist or wheel but seems to only cover the former. Wheels (and previously eggs) seem to be "Built Distribution"'s and not "Distribution Archive"'s.
If that sounds right, then this PR LGTM.
TBH, the terminology is a bit of a mess, and no-one uses most of it in real life. The key term in my view is "Distribution Package", and that's commonly used to mean either a wheel or a sdist1. Personally I use "Distribution File" when I want to be 100% clear I'm talking about a physical file on disk (and I'm surprised to see that "Distribution Archive" is the official term for that, and somewhat disappointed as I think it's less clear - one of the ways it's less clear is that the term "archive" doesn't feel like it applies to wheels, whereas the term "file" obviously does). The key point for me is that the revised wording is clear in its intent, and I think it is. We can consider replacing the term "Distribution Archive" with "Distribution File" (globally, not just here) as a separate exercise, if anyone thinks it's important enough to spend time on. Footnotes
|
Thanks for the context @pfmoore, that helped. I re-read the files being changed in full, and I think this PR is fine indeed - it achieve the "distribution license not project's contributing license" well enough, and this PR is unrelated to |
Approved in https://discuss.python.org/t/split-from-pep-639-expressing-project-vs-distribution-licenses-post-pep-639-mod-titled/90314/179 .
📚 Documentation preview 📚: https://python-packaging-user-guide--1909.org.readthedocs.build/en/1909/