pypa / pypa/packaging.python.org

Possible reference link: "A guided tour from the Python REPL to PyPI & beyond"

Open
#382 9 comments 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Python
Stars
1.7k
Forks
1.7k
Avg merge
3d 12h
Merged PRs (30d)
4

Description

https://veekaybee.github.io/2017/09/26/python-packaging/ is an interesting article from @veekaybee that starts from the simplest possible Python component (a single statement at the REPL), and works its way all the way through to publication of a package with multiple submodules.

(Note: the article's actual title is "Alice in Python projectland", so the quoted bit in the issue title is just how I'd summarise what it's about)

https://packaging.python.org/tutorials/distributing-packages/#configuring-your-project is deliberately very prescriptive without really answering many "Why is it so?" questions, so this could be a good "See Also:" link at the start of that section for folks that want a better understanding of the bigger picture, rather than just following a prescriptive recipe.

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

Read the packaging.python.org “Configuring your project” section and the linked “Alice in Python projectland” article. Add the article as a See Also link at the start of that section, then verify that the rendered documentation link works and provides the intended broader explanation.

Written by the indexing model from the issue text.

Assessment

Tech stack
python
Domain
documentation
Issue type
Documentation
Difficulty
1/5
Estimated time
Under an hour
Activity status
Stale
Clarity
Clearly specified
Newbie friendliness
42/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.