fix: PEP 621 license field #619
Merged
Conversation
This file contains hidden or 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
airtower-luna
added a commit
to crystal-cat/exif_rename
that referenced
this pull request
Aug 17, 2022
I noticed wntrblm/nox#619 and it turns out the issue affects "pip show" as well: If the license field is set to a file, the whole content of the file is quoted in the pip output, which is unwieldy. Specify a short identifier instead, the COPYING file is still available.
airtower-luna
added a commit
to crystal-cat/exif_rename
that referenced
this pull request
Aug 17, 2022
I noticed wntrblm/nox#619 and it turns out the issue affects "pip show" as well: If the license field is set to a file, the whole content of the file is quoted in the pip output, which is unwieldy. Specify a short identifier instead, the COPYING file is still available.
crystal-cat
pushed a commit
to crystal-cat/exif_rename
that referenced
this pull request
Aug 18, 2022
I noticed wntrblm/nox#619 and it turns out the issue affects "pip show" as well: If the license field is set to a file, the whole content of the file is quoted in the pip output, which is unwieldy. Specify a short identifier instead, the COPYING file is still available.
crystal-cat
pushed a commit
to crystal-cat/exif_rename
that referenced
this pull request
Apr 24, 2023
I noticed wntrblm/nox#619 and it turns out the issue affects "pip show" as well: If the license field is set to a file, the whole content of the file is quoted in the pip output, which is unwieldy. Specify a short identifier instead, the COPYING file is still available.
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.
I've discovered (by accident) something quite unfortunate about the PEP 621 pyproject.toml
licensefield. I recently ported pytoil to support PEP 621 and released a new version with the following config:However this gives a rather ugly representation of the entire file on PyPI:
This can be fixed by simply passing the name of the license in the
textkey like so:Which results in what you'd expect:
And I can confirm that the full LICENSE file is still included when running
pyproject-build: