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

Use SPDX license expression #125

Merged
merged 2 commits into from
Nov 19, 2024
Merged

Use SPDX license expression #125

merged 2 commits into from
Nov 19, 2024

Conversation

cdce8p
Copy link
Contributor

@cdce8p cdce8p commented Nov 18, 2024

Use the SPDX license identifier as recommended by PEP 639.
https://spdx.org/licenses/GPL-3.0-or-later.html

aioconsole/LICENSE

Lines 637 to 640 in cfca2d3

This program is free software: you can redistribute it and/or modify
it under the terms of the GNU General Public License as published by
the Free Software Foundation, either version 3 of the License, or
(at your option) any later version.

Copy link

codecov bot commented Nov 19, 2024

Codecov Report

All modified and coverable lines are covered by tests ✅

Project coverage is 94.22%. Comparing base (cfca2d3) to head (bd2cae1).
Report is 3 commits behind head on main.

Additional details and impacted files
@@           Coverage Diff           @@
##             main     #125   +/-   ##
=======================================
  Coverage   94.22%   94.22%           
=======================================
  Files          11       11           
  Lines         848      848           
=======================================
  Hits          799      799           
  Misses         49       49           

☔ View full report in Codecov by Sentry.
📢 Have feedback on the report? Share it here.


🚨 Try these New Features:

@vxgmichel
Copy link
Owner

Oh I didn't know about that.

If you are using a standard, well-known license, it is not necessary to use this field. Instead, you should use one of the classifiers starting with License ::.

https://packaging.python.org/en/latest/guides/writing-pyproject-toml/#license

Does that mean we should add the following classifier and remove the license field altogether?

License :: OSI Approved :: GNU General Public License v3 or later (GPLv3+)

What do you think?

@cdce8p
Copy link
Contributor Author

cdce8p commented Nov 19, 2024

Does that mean we should add the following classifier and remove the license field altogether?

What do you think?

IMO that section in the packaging guide is outdated. There is an open issue to rework it but nobody has gotten around to it yet.

The future will definitely be the license expression defined with just license = "GPL-3.0-or-later". Unfortunately setuptools doesn't yet support that syntax. So the next best thing would be to use the license expression with the old license field, i.e. with license = {text = "GPL-3.0-or-later"}, until then.

I've just added the classifier as well. Although personally I'd consider it optional with the license field.
Tools looking for project licenses can't rely on it already as some classifiers map to more than one license option. (Not the case here though.)

@vxgmichel vxgmichel merged commit 61bcb23 into vxgmichel:main Nov 19, 2024
28 checks passed
@vxgmichel
Copy link
Owner

Alright, thanks for the explanation and the PR :)

@cdce8p cdce8p deleted the cdce8p-patch-1 branch November 19, 2024 21:05
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