Support specifying the license file in the pyproject.toml file #1812
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
MarieRoald
force-pushed
the
pep621-license-file
branch
from
048bd37
to
62331ea
Compare
freakboy3742
requested changes
May 21, 2024
There was a problem hiding this comment.
Summary of in-person discussion: This is great; however, we probably want to:
- Preserve the PEP621 structure of the
licensefield as a dictionary - If the
filesub-field is used, use that as the file name (rather than a separatelicense_filefield) - If the
textsub-field is used, output that text as aLICENSEfile - possibly with a warning if the text doesn't appear to be a full license text - If
licenseis a bare string (which will be the legacy behavior from older Briefcase projects), issue a warning and convert it tolicense = {"file": "LICENSE"}, since we know the license will be a file.
MarieRoald
force-pushed
the
pep621-license-file
branch
from
62331ea
to
96734be
Compare
MarieRoald
force-pushed
the
pep621-license-file
branch
2 times, most recently
from
2afd560
to
1fcaa9e
Compare
Signed-off-by: Yngve Mardal Moe <yngve.m.moe@gmail.com> Signed-off-by: Marie Roald <roald.marie@gmail.com> Co-authored-by: Yngve Mardal Moe <yngve.m.moe@gmail.com>
MarieRoald
force-pushed
the
pep621-license-file
branch
from
1fcaa9e
to
67575d4
Compare
There was a problem hiding this comment.
Looks good! There's obviously a few gaps related to license.text handling, but those are going to be difficult to address without a fix for #1829. I'll take a swing at some of the language in the error messages before this lands, but otherwise, I think this is good to land!
4 tasks
freakboy3742
approved these changes
May 27, 2024
4 tasks
4 tasks
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Briefcase can now read the
project.license.file-key in thepyproject.tomlfile. Without this PR, the license file name is hard-coded to "LICENSE". This is relevant for linux builds, where the license file is included in the built package. With this PR, it still defaults to "LICENSE", but ifproject.license.fileis set inpyproject.toml, then that file is used instead.This is related to the LICENSE file handling in #1235
PR Checklist: