pypa / pypa/packaging.python.org

Document discouraged / deprecated setup arguments

Open
#293 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

type: enhancement
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:

  1. requires dates from a pre-PyPI & setuptools time and has now been replaced by install_requires.
  2. provides is unused.
  3. obsoletes is unused.
  4. platforms has ambiguous behavior.
  5. dependency_links isn't supported by pip.
  6. download_url has surprising behavior and shouldn't be used.

(Original context: #264)

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

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.