pypa / pypa/packaging.python.org

New tutorials: write section to define and describe "package"

Open
#199 7 comments 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

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

Description

(For more information about this issue, please see #194).

We need a short section to follow the prerequisites section (see #196) (i.e., as its own file). It should satisfy the following goals:

  • explain what a distribution package is
  • explain how a distribution package differs from import packages and modules
  • use the terminology that the wider Python Packaging User Guide uses, so the terminology is familiar if the reader turns to another part of the guide

I also think it would be helpful if the section could illustrate each point with some kind of example, either a made-up example or a real-world example, if it's not too complicated.

When opening pull requests for this issue, please submit to the develop branch. If you have questions that concern contributing more generally, please use issue #194. Otherwise, feel free to comment with questions or feedback. Thanks!

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 reviewing the prerequisites section referenced in the issue and the linked Python Packaging User Guide glossary entries for distribution packages, import packages, and modules. The work is complete when a standalone section file follows the prerequisites, uses the guide’s terminology, and includes clear examples distinguishing each concept; submit changes to the develop branch.

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
48/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.