pypa / pypa/setuptools

[Docs]

Open
#4,093 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

documentation Needs Triage
Dominant language
Python
Stars
2.9k
Forks
1.4k
Avg merge
1d 1h
Merged PRs (30d)
1

Description

Summary

Was reading the documentation for setuptools v68.2.2 and have problems understanding the meaning of the 'license' meta-data field, see https://setuptools.pypa.io/en/stable/deprecated/distutils/setupscript.html#additional-meta-data

The license field is a text indicating the license covering the package where the license is not a selection from the “License” Trove classifiers.

For me it is unclear, what this "where … is not a selection from" means:

  • Is this fields only to be set if the license is not one of those available as “License” Trove classifier?
  • Is the field allowed to be set if the license is not one of those available as “License” Trove classifier?
  • Does this field take precedence over any “License” Trove classifier listed in the package? Or the other way round?
OS / Environment

n/a

Additional Information

Proposal for rewording:

The license field is a text indicating the license covering the package if the license of the package is available as the “License” Trove classifiers.
If the license is available as “License” Trove classifier, please use that one and leave the license field away.
If the license is not available as “License” Trove classifier, please set “License” Trove classifier to License :: Other/Proprietary License and briefly state the license here.

Code of Conduct
  • I agree to follow the PSF Code of Conduct

Contributor guide

No contributing guide indexed for this repository

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Open the linked setuptools documentation section on the license metadata field first and compare its wording with the issue's proposed clarification. Update the documentation so the relationship between the field and License Trove classifiers is unambiguous, then verify the rendered section communicates when each should be used.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
50/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.