pypa / pypa/packaging.python.org
Document discouraged / deprecated setup arguments
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 1.7k
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 4
Description
We presently document an opinionated set of setup args that are applicable to most packaging scenarios. We also have additional topics for more advanced use cases. However, we don't presently document arguments that should never be used or used with extreme caution.
So far, the ones I'm aware of are:
requiresdates from a pre-PyPI & setuptools time and has now been replaced byinstall_requires.providesis unused.obsoletesis unused.platformshas ambiguous behavior.dependency_linksisn't supported by pip.download_urlhas surprising behavior and shouldn't be used.
(Original context: #264)
Contributor guide
No contributing guide indexed for this repository
First steps
- Read the whole issue, then the project's contributing guide.
- Comment on the issue to say you are picking it up — it saves two people doing the same work.
- Fork the repository and make your change on a branch.
- Open a pull request that references the issue number.
Research direction
Review the existing documentation for setup arguments and the context in issue #264 before deciding where these notes belong. Document the cautions for requires, provides, obsoletes, platforms, dependency_links, and download_url, with completion marked by all six arguments being covered.
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
- Clearly specified
- Newbie friendliness
- 45/100