pypa / pypa/packaging.python.org

Update sdist specification section to refer to PEP 517

Open
#388 2 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

good first issue type: enhancement
Dominant language
Python
Stars
1.7k
Forks
1.7k
Avg merge
3d 12h
Merged PRs (30d)
4

Description

(Filing as an issue rather than a PR to avoid conflicting with @di's PR at #386)

https://www.python.org/dev/peps/pep-0517/#source-trees defines a new sdist format for use with PEP 517 compatible build frontends.

The relevant specific subsection should be updated to mention the provisional acceptance of that format, but note that publishing tools should still provide setup.py shims for the time-being (since it will be a while before native PEP 517 is widespread in frontends)

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 locating the sdist specification subsection in the packaging.python.org documentation and read PEP 517's Source trees section. Update that subsection to mention provisional acceptance of the PEP 517 sdist format while retaining the guidance about setup.py shims; confirm the wording does not conflict with PR #386.

Written by the indexing model from the issue text.

Assessment

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

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.