pypa / pypa/packaging.python.org

New tutorials: write section to describe sources of packages

Open
#200 2 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 "What's a package?" section (see #199) (i.e., as its own file). It should satisfy the following goals (in no particular order):

  • explain that packages can be distributed through many channels (e.g., downloaded from PyPI with a tool like pip, an archive downloaded from a website, a VCS repository)
  • explain that PyPI is an extremely popular way of getting packages but not the only way
  • explain that PyPI is an index of packages, but not the only possible index
  • illustrate the point with an example (maybe mention a popular package, then describe how it can be found on PyPI, in a VCS repository, and downloaded from the project's website)

In short, this section should answer the question, Where do packages come from?

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 reading the existing "What's a package?" section and the related issues #194 and #199. Add a short section as its own file explaining package distribution channels, PyPI and other indexes, and one package example covering PyPI, a VCS repository, and the project website. Submit the pull request 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
55/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.