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

update license metadata to use SPDX identifier as per recommendation #125

Open
wants to merge 1 commit into
base: main
Choose a base branch
from

Conversation

imrehg
Copy link

@imrehg imrehg commented May 12, 2023

This is a housekeeping code change suggestion. This project is released under the MIT license as per the LICENSE file's contents, however the current metadata notation makes handling that information harder than it should be.

The PEP621's license field info generally recommends using a SPDX-compatible license identifier, which in this case is "MIT". Before this proposed change, other tools that use metadata-extraction (such as pip-licenses) hiccups on the license value on this library, not being able to infer that it's the same license as many other projects as well.

Given how licensing applies, I believe this should be without downside and any loss of clarity or control on the side of the project's creators, while having definite (even if niche) upside for the project's users. Happy to bring in examples from other MIT-licensed projects that use the same format.

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.

1 participant