Commit Graph

11 Commits

Author SHA1 Message Date
CAM Gerlach 670de668d4
PEP 639: Clarify License-File field, slim down terminology & remove future PEPs (#2298)
* PEP 639: Remove speculative future PEPs section and cut down terminology

* PEP 639: Clarify intended role of License-File field in other formats

* PEP 639: Move User Scenarios to an appendix and de-number

* PEP 639: Apply suggestions from Adam's reivew and other refinements
2022-02-03 17:16:44 -06:00
Adam Turner 113e490701
Several PEPs: Use explicit `:pep:` and `:rfc:` roles (#2209) 2022-01-21 11:03:51 +00:00
CAM Gerlach 6c7fa9746f
PEP 639: Update PEP delegate, post history and CODEOWNERS (GH-2228) 2022-01-20 08:04:25 +00:00
Shantanu ace871d870
Various PEPs: fix typos (GH-2211)
Co-authored-by: hauntsaninja <>
2022-01-03 21:01:23 -08:00
CAM Gerlach 80e009085f
PEP 639: Make requested additions and changes, add additional helpful info, reformat, update and copyedit (#2164)
* PEP 639: Reframe core metadata update as discrete proposal per PEP 643

* PEP 639: Clean up formatting, syntax, spelling, headers and lists

* PEP 639: Rewrite to reflect License-Expression field and depr process

* PEP 639: Update examples, current tools survey, links and more

* PEP 639: Add PEP 621, expand/move examples & reorganize/shorten headings

* PEP 639: Further specify and clarify license file handling

* PEP 639: Add additional ambigous classifiers and tool recommendations

* PEP 639: Rework PEP 621 keys, refine dynamic/globs & add rejected ideas

* PEP 639: Specify license path root & subdirs, & expand examples

* PEP 639: Add license_files dir, rejected ideas & sdist/wheel/installed

* PEP 639: Add PyPI validation of new fields for newly-uploaded files

* PEP 639: Add open isssue for back-filling & reject per-dist licenses

* PEP 639: Add User Scenarios to provide guidance for common use cases

* PEP 639: Update Abstract, Goals, Rationale, Compat. & other sections

* PEP 639: Add terminology section & use consistant, clear & correct terms

* PEP 639: Make refs inline per #2130, add links, fix others & refine text

* PEP 639: Copyedit and proofread for grammar, phrasing, clarity & tone

* PEP 639: Address reviewer and community feedback

* PEP 639: Add custom IDs issue & clarify rejected license key str value
2021-12-17 15:20:01 -08:00
Hugo van Kemenade a2890cf4bc
PEP 621, 635, 637, 639, 642, 644, 645, 647, 650: Fix single backticks (#1797) 2021-02-05 08:09:26 -08:00
Marti Raudsepp 9b64c6ea75
Various typo/grammar/style fixes (#1789)
Changes detected by Topy (https://github.com/intgr/topy), all changes
verified by hand, false positives have been omitted.

These range from straight-out misspellings to debatable hyphen placement.
The hyphen changes are supported by grammar manuals of style.
2021-02-03 06:06:23 -08:00
Kevin P. Fleming faf6247812
PEP 639: Changes for clarity and consistency (#1780) 2021-02-02 12:58:38 -08:00
Philippe Ombredanne be94151aaf
PEP 639: Minor typo fixes (#1656) 2020-10-16 12:39:49 -07:00
Dustin Ingram 4bd3577610
PEP 639: edits from review (#1628)
* Fix monospaces

* The 'license expression' term shouldn't be monospaced/capitalized

* Rephrasing

* Fix capitalization of titles

* Make it clear when we're talking about the Classifiers field vs classifiers

* More monospace fixes

* Edits for clarity

* Fix 'License ::' prefix

* Update link

* More tweaks for clarity

* Fix broken ref

Co-authored-by: Philippe Ombredanne <pombredanne@gmail.com>
Co-authored-by: Jelle Zijlstra <jelle.zijlstra@gmail.com>
2020-09-30 16:13:58 +02:00
Philippe Ombredanne fa61557ccc
PEP 639: Use SPDX license expressions in Core package metadata (#1625)
* Add PEP draft for SPDX license expressions

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

* Add reference to another license-related ticket

https://github.com/pypa/packaging-problems/issues/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>
2020-09-28 17:58:34 +10:00