pypa / pypa/packaging.python.org

Give a clear recommendation on what sdists should contain

Open
#1,494 18 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

component: guides component: specifications state: blocked type: task
Dominant language
Python
Stars
1.7k
Forks
1.7k
Avg merge
3d 12h
Merged PRs (30d)
4

Description

There is currently confusion in the ecosystem around what sdists should contain, and specifically

  • whether they should contain tests and documentation
  • whether they should contain auxiliary files (e.g., maintenance scripts)

This is an issue for downstream packagers, who normally want at least the tests. If sdists should contain tests, downstream packagers should be able to use sdists from PyPI and sdists which currently do not contain tests should be changed by upstream authors. If sdists should not contain tests, packagers should migrate to using upstream sources like VCS checkouts.

There has been no real consensus so far, AFAICS. The discussions were

https://discuss.python.org/t/should-sdists-include-docs-and-tests/14578

and

https://discuss.python.org/t/sdists-for-pure-python-projects/25191/40

Once a consensus is reached, it should be reflected in the guide.

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

Start by reading the two linked discussions about whether sdists should include tests, documentation, and auxiliary files. Determine whether a consensus has been reached and what recommendation it supports. Done means reflecting that recommendation in the packaging guide; the issue does not name a specific guide file.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
5/5
Estimated time
Over a week
Activity status
Stale
Clarity
Needs clarification
Newbie friendliness
25/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.