pypa / pypa/packaging.python.org
Add topic guides based on Discourse Discussion
Nobody has claimed this yet.
- Dominant language
- Python
- Stars
- 1.7k
- Forks
- 1.7k
- Avg merge
- 3d 12h
- Merged PRs (30d)
- 4
Description
https://discuss.python.org/t/user-experience-with-porting-off-setup-py/37502/77#topic-guides-1
Topic Guides
-
Packaging a pure-Python project with basic defaults
Walk through the simplest possible case. Given some of the more important definitions. This needs to mention that backends, etc exists, and link to other guides. It is important to convey to beginners that if they hit a wall with simplest things, that there is more to look into, and some idea where. -
Using and choosing build backends
Has many definitions: what is a backend, why does it matter? Discussions and comparisons of common/popular backends and their configuration, at least one full example, and lots of links to backend projects docs. -
Handling advanced cases with compilation steps
A couple of full examples, discussion and links of tools like scikit-build or advanced build capabilities of other backends. There’s lots to potentially cover here, or at least mention and link to things about: cython, wrapping C, C++ or Fortran, building/bundling Typescript. Maybe suggest DPO as a place for deep technical questions. -
Publishing packages
Information about PyPI and twine. -
Modernizing legacy setup.py usage
Address all the things that came up for the OP here, links to the other guides as appropriate. Quick tips/FAQs for common things e.g. “what do I do with these command line arguments?”
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
Start with the linked Discourse discussion and the unchecked guide list in this issue. Define the scope and structure for guides covering basic pure-Python packaging, build backends, compilation cases, and publishing with PyPI and twine. Done means each unchecked guide has beginner-oriented explanations, relevant examples, and links to deeper documentation; the legacy setup.py guide is already marked complete.
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
- Mostly clear
- Newbie friendliness
- 35/100