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.

Sign up for GitHub

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

Jump to bottom

PEP 639: Use SPDX license expressions in Core package metadata #1625

Merged
merged 42 commits into from
Sep 28, 2020
Merged

PEP 639: Use SPDX license expressions in Core package metadata #1625

merged 42 commits into from
Sep 28, 2020

Conversation

pombredanne
Copy link
Contributor

This is a new PEP to improve the license information handled in Core metadata which is now more than ready to enter the formal PEP process.

The discussion has been taking at https://discuss.python.org/t/improving-license-clarity-with-better-package-metadata/2154 and in the original PR on my fork pombredanne#2

This has been triggered by several discussions in particular:

Signed-off-by: Philippe Ombredanne pombredanne@nexb.com

pombredanne and others added 29 commits September 27, 2020 18:55
@pombredanne
Add PEP draft for SPDX license expressions
7e46cc8 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Add reference to another license-related ticket
1eaec3a 
pypa/packaging-problems#41

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Add proper Draft status
0f1d0b7 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Direct PEP discussions to discuss.python.org
fd9895e 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Adopt latest PEP copyright conventions
43c0c1e 
Reported-by: Aliaksei Urbanski @Jamim
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Add @pf_moore as BDFL delegate.
86119d4 
And fix minor typo

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Add Paul Moore as a PEP sponsor
e1b027d 
CC: @pfmoore
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Reuse License Field. Add License-File.
1e05161 
Do not deprecate the License field with a new field. Instead reuse
License and provide backward compatibility.

Also add License-File field already in use in wheel and setuptools.

Integrates latest feedback

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Add packaging license metadata survey sections
08859dc 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Add poetry and flit references
89fad3b 
CC: @takluyver and @sdispater
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne @pradyunsg
Fix typo
dbde90a 
Reported-by: Pradyun Gedam @pradyunsg
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>
@pombredanne @pradyunsg
Fix typo and improve subtitle
b0681c4 
Reported-by: Pradyun Gedam <pradyunsg@gmail.com>
Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne @pradyunsg
Fix typo
5ebad29 
Reported-by: Pradyun Gedam <pradyunsg@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>
@pombredanne @pradyunsg
Fix typo
fb91d46 
Reported-by: Pradyun Gedam <pradyunsg@gmail.com>
Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Use appendix and use footnotes for links
3824483 
Also improve formatting

Reported-by: Pradyun Gedam @pradyunsg
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Add new sections and improve existing sections
bb8e3c1 
- Refactor intro with new and improved abstract, scope, non-scope,
motivation and rationale sections
- Add new Backwards Compatibility, Security and How to Teach sections
- Move Reference Implementation out of appendix as its own section
- Add new Rejected ideas section
- Add new License Expression example using setuptools in Appendix

Reported-by: Chris Jerdonek @cjerdonek
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne @pradyunsg
Fix typo
0cb7f26 
Reported-By: Pradyun Gedam <pradyunsg@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>
@pombredanne @pradyunsg
Fix typo
8a352cf 
Reported-By: Pradyun Gedam <pradyunsg@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>
@pombredanne @pradyunsg
Improve presentation
f26c8e4 
Reported-By: Pradyun Gedam <pradyunsg@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>
@pombredanne @pradyunsg
Improve style
c98cd13 
Reported-By: Pradyun Gedam <pradyunsg@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>
@pombredanne
Move setuptools and wheel notes on license-file out
4637124 
Reported-by: Nick Coghlan @ncoghlan
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Clarify and discourage use of public domain
161354c 
Reported-by: Nick Coghlan @ncoghlan
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Fix typo
67a5e04 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Fix typos and clarify multi classifiers migrations
e900fc9 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Report warning for expression case
453b65c 
The case does nt matter, but there is a canonical case: if the case
is the not the standard canonical case, tools should issue a warning.

Reported-by: Oleg Grenrus @phadej
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Use deprecated not obsolete per SPDX
fcaaf6b 
Reported-by: Oleg Grenrus @phadej
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Correct Cabal that uses SPDX expressions
ad39305 
Cabal uses both expressions and license files as proposed in this PEP

Reported-by: Oleg Grenrus @phadej
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Fix typo
fdef4fd 
Reported-by: Oleg Grenrus @phadej
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Use LicenseRef- prefix for non-standard SPDX ids
f07819c 
This help endsure that the expressions is fully parseable by a
conforming license expression processor

Reported-by: Oleg Grenrus @phadej
Reported-by: Nick Coghlan @ncoghlan
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@the-knights-who-say-ni
Copy link

Hello, and thanks for your contribution!

I'm a bot set up to make sure that the project can legally accept this contribution by verifying everyone involved has signed the PSF contributor agreement (CLA).

Recognized GitHub username

We couldn't find a bugs.python.org (b.p.o) account corresponding to the following GitHub usernames:

@Steap

This might be simply due to a missing "GitHub Name" entry in one's b.p.o account settings. This is necessary for legal reasons before we can look at this contribution. Please follow the steps outlined in the CPython devguide to rectify this issue.

You can check yourself to see if the CLA has been received.

Thanks again for the contribution, we look forward to reviewing it!

@pombredanne pombredanne mentioned this pull request Sep 27, 2020
Closed
@pombredanne
Copy link
Contributor Author

@Steap ping. Your commits in this PR makes the CLA bot unhappy. We can solve this with either:

  1. you signing a CLA
  2. me squashing your commit and removing you from the commit history. You are already in Acknowledgements in all cases.

Thanks!

@pombredanne
Copy link
Contributor Author

Dear @python/pep-editors this belated PR is ready for your consideration and get a number assigned!

@Steap
Copy link

Steap commented Sep 27, 2020

  1. me squashing your commit and removing you from the commit history. You are already in Acknowledgements in all cases.

OK, let's do this :) Thanks for working on this.

pombredanne and others added 11 commits September 27, 2020 20:03
@pombredanne
Fix typos.
4842b9c 
Reporte-by: Cyril Roelandt <tipecaml@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Fix typo and add BSD* distributions reference
6527b96 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Fix typo and improve grammar
42bb89f 
Reported-by: Nick Coghlan @ncoghlan
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pradyunsg @pombredanne
Copy Edits for initial sections
90ae2e7
@pradyunsg @pombredanne
Reword a paragraph
0283c59
@pradyunsg @pombredanne
Update pep-9999.rst
877cc4e
@pombredanne
Fix typo
5cbeff7 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne @pradyunsg
Remove erroneous leading spaces
cc240bb 
Reported-by: Pradyun Gedam @pradyunsg
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Co-authored-by: Pradyun Gedam <pradyunsg@gmail.com>
@pombredanne
Update SPDX license list and spec versions
46f46e1 
Use latest SPDX spec 2.2 and SPDX license list 3.10

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Fix typos and formatting
1d1829d 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne
Clarify License file path definition
0fe3434 
Reported-by: Miro Hrončok @hroncok
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
uranusjr
uranusjr reviewed Sep 27, 2020
View reviewed changes
pep-9999.rst Outdated
Author: Philippe Ombredanne <pombredanne at nexb.com>
Sponsor: Paul Moore <p.f.moore at gmail.com>
BDFL-Delegate: Paul Moore <p.f.moore at gmail.com>
Discussions-To: https://discuss.python.org/t/improving-license-clarity-with-better-package-metadata
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I prefer using the ID here since the slug changes if you edit the title. This should reliably point to the same thread: https://discuss.python.org/t/2154

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

@uranusjr done

@pombredanne
Use permalink for discussion link
eae8321 
Reported-by: Tzu-ping Chung @uranusjr
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@Rosuav
Copy link
Contributor

Rosuav commented Sep 27, 2020

It looks like 639 is the next available number, so go ahead and claim that one. CLA bot is now happy, so I think that's the final barrier to merging.

@pombredanne
Assign number as PEP-0639
cc56df4 
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>
@pombredanne pombredanne changed the title PEP 9999: Use SPDX license expressions in Core package metadata PEP 639: Use SPDX license expressions in Core package metadata Sep 28, 2020
@pombredanne
Copy link
Contributor Author

It looks like 639 is the next available number, so go ahead and claim that one. CLA bot is now happy, so I think that's the final barrier to merging.

@Rosuav done! thank you.

@Rosuav
Copy link
Contributor

Rosuav commented Sep 28, 2020

LGTM!

@Rosuav Rosuav merged commit fa61557 into python:master Sep 28, 2020
@pradyunsg
Copy link
Member

Thanks @Rosuav! ^>^

mnm678 pushed a commit to mnm678/peps that referenced this pull request Oct 22, 2020
@pombredanne @pradyunsg @mnm678
PEP 639: Use SPDX license expressions in Core package metadata (pytho…
b90ad84 
…n#1625)

* Add PEP draft for SPDX license expressions

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Add reference to another license-related ticket

pypa/packaging-problems#41

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Add proper Draft status

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Direct PEP discussions to discuss.python.org

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Adopt latest PEP copyright conventions

Reported-by: Aliaksei Urbanski @Jamim
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Add @pf_moore as BDFL delegate.

And fix minor typo

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Add Paul Moore as a PEP sponsor

CC: @pfmoore
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Reuse License Field. Add License-File.

Do not deprecate the License field with a new field. Instead reuse
License and provide backward compatibility.

Also add License-File field already in use in wheel and setuptools.

Integrates latest feedback

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Add packaging license metadata survey sections

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Add poetry and flit references

CC: @takluyver and @sdispater
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Fix typo

Reported-by: Pradyun Gedam @pradyunsg
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>

* Fix typo and improve subtitle

Reported-by: Pradyun Gedam <pradyunsg@gmail.com>
Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Fix typo

Reported-by: Pradyun Gedam <pradyunsg@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>

* Fix typo

Reported-by: Pradyun Gedam <pradyunsg@gmail.com>
Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Use appendix and use footnotes for links

Also improve formatting

Reported-by: Pradyun Gedam @pradyunsg
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Add new sections and improve existing sections

- Refactor intro with new and improved abstract, scope, non-scope,
motivation and rationale sections
- Add new Backwards Compatibility, Security and How to Teach sections
- Move Reference Implementation out of appendix as its own section
- Add new Rejected ideas section
- Add new License Expression example using setuptools in Appendix

Reported-by: Chris Jerdonek @cjerdonek
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Fix typo

Reported-By: Pradyun Gedam <pradyunsg@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>

* Fix typo

Reported-By: Pradyun Gedam <pradyunsg@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>

* Improve presentation

Reported-By: Pradyun Gedam <pradyunsg@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>

* Improve style

Reported-By: Pradyun Gedam <pradyunsg@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Co-Authored-By: Pradyun Gedam <pradyunsg@gmail.com>

* Move setuptools and wheel notes on license-file out

Reported-by: Nick Coghlan @ncoghlan
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Clarify and discourage use of public domain

Reported-by: Nick Coghlan @ncoghlan
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Fix typo

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Fix typos and clarify multi classifiers migrations

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Report warning for expression case

The case does nt matter, but there is a canonical case: if the case
is the not the standard canonical case, tools should issue a warning.

Reported-by: Oleg Grenrus @phadej
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Use deprecated not obsolete per SPDX

Reported-by: Oleg Grenrus @phadej
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Correct Cabal that uses SPDX expressions

Cabal uses both expressions and license files as proposed in this PEP

Reported-by: Oleg Grenrus @phadej
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Fix typo

Reported-by: Oleg Grenrus @phadej
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Use LicenseRef- prefix for non-standard SPDX ids

This help endsure that the expressions is fully parseable by a
conforming license expression processor

Reported-by: Oleg Grenrus @phadej
Reported-by: Nick Coghlan @ncoghlan
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Fix typos.

Reporte-by: Cyril Roelandt <tipecaml@gmail.com>
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Fix typo and add BSD* distributions reference


Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Fix typo and improve grammar


Reported-by: Nick Coghlan @ncoghlan
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Copy Edits for initial sections

* Reword a paragraph

* Update pep-9999.rst

* Fix typo


Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Remove erroneous leading spaces

Reported-by: Pradyun Gedam @pradyunsg
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Co-authored-by: Pradyun Gedam <pradyunsg@gmail.com>

* Update SPDX license list and spec versions

Use latest SPDX spec 2.2 and SPDX license list 3.10

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Fix typos and formatting

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Clarify License file path definition

Reported-by: Miro Hrončok @hroncok
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Use permalink for discussion link

Reported-by: Tzu-ping Chung @uranusjr
Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

* Assign number as PEP-0639

Signed-off-by: Philippe Ombredanne <pombredanne@nexb.com>

Co-authored-by: Pradyun Gedam <pradyunsg@gmail.com>
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Reviewers

@uranusjr uranusjr uranusjr left review comments

Assignees
No one assigned
Labels
CLA signed
Projects
None yet
Milestone
No milestone
Development

Successfully merging this pull request may close these issues.
6 participants
@pombredanne @the-knights-who-say-ni @Steap @Rosuav @pradyunsg @uranusjr