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

chore: remove unnecessary license clause #122

Merged

Conversation

asfaltboy
Copy link
Contributor

@asfaltboy asfaltboy commented Feb 21, 2024

Setting this field makes the entire GPLv2 license text appear when viewing the package metadata, e.g. with pip show flake8-builtins.

I feel this is a bit too verbose, and unnecessary.

As described in the python packaging guide it is not necessary to specify this field when using a standard license. Actually, this might be more confusing to users, as they may avoid the package if a modified license is implied:

If you are using a standard, well-known license, it is not necessary
to use this field. Instead, you should one of the classifiers starting
with License ::. (As a general rule, it is a good idea to use a
standard, well-known license, both to avoid confusion and because some
organizations avoid software whose license is unapproved.)

Since this package already uses the 'License' classifier, I think removing this from pyproject.toml should remove it from the metadata when uploading to pypi with hatchling.

Setting this field makes the entire GPLv2 license text appear when
viewing the package metadata e.g with `pip show flake8-builtins`.

I feel this is a bit too verbose, and unnecessary.

As described in the [python packaging guide] it is not necessary to
specify this field when using a standard license. Actually this might be
more confusing to users, as they may avoid the package if a modified
license is implied:

> If you are using a standard, well-known license, it is not necessary
> to use this field. Instead, you should one of the classifiers starting
> with License ::. (As a general rule, it is a good idea to use a
> standard, well-known license, both to avoid confusion and because some
> organizations avoid software whose license is unapproved.)

[python packaging guide]: https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#license
@gforcada
Copy link
Owner

Sorry for the late response 😓

I did not even now that pip show XXX ever existed 🎉 thanks! 👍🏾

@gforcada gforcada merged commit e98d973 into gforcada:main Feb 25, 2024
7 checks passed
@asfaltboy asfaltboy deleted the ps/simplify-license-package-metadata branch March 25, 2024 12:51
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