pypa / pypa/packaging.python.org

Write introduction to new packaging tutorials

Open
#195 4 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).

To kick off the introductory tutorial to Python packaging, we need a short section that answers the questions Who is this tutorial for? and What will be covered in the tutorial?.

For the first question, that means Python users who are at at least an "advanced beginner" level. They should be comfortable importing something from the standard library and comfortable with using common language features (like loops and if statements). Readers who want to learn to program with Python should be directed elsewhere.

The remainder of the intro should briefly describe what the reader can expect to learn by completing the guide. See #194 for details.

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

Read issue #194 first for the packaging tutorial details, then identify the introductory tutorial section that needs the new text. Write a short introduction covering the intended audience and what the guide teaches, and submit the pull request against 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
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.