pypa / pypa/packaging.python.org

New tutorials: write section to describe sources of packages

Offen
#200 2 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

component: tutorials
Vorherrschende Sprache
Python
Sterne
1.7k
Forks
1.7k
Ø Merge
3 T. 12 Std.
Gemergte PRs (30 T.)
4

Beschreibung

(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!

Beitragsleitfaden

Für dieses Repository ist kein Beitragsleitfaden indexiert

Erste Schritte

  1. Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
  2. Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
  3. Forke das Repository und arbeite in einem Branch.
  4. Öffne einen Pull Request, der die Issue-Nummer nennt.

Rechercherichtung

Beginnen Sie damit, den vorhandenen Abschnitt "What's a package?" und die zugehörigen Issues #194 und #199 zu lesen. Fügen Sie als eigene Datei einen kurzen Abschnitt hinzu, der Paketverteilungskanäle, PyPI und andere Indizes sowie ein Paketbeispiel erklärt, das PyPI, ein VCS-Repository und die Projektwebsite abdeckt. Reichen Sie den Pull Request beim develop-Branch ein.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
2/5
Geschätzter Aufwand
1-3 Stunden
Aktivitätsstatus
Veraltet
Klarheit
Klar beschrieben
Anfängerfreundlichkeit
55/100

Neue Issues direkt in Ihr Postfach

Eine kurze Übersicht über anfängerfreundliche GitHub-Issues.