python / python/mypy

Update PEP 561 examples with modern packaging

Offen
#13,901 4 Kommentare 5 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

documentation topic-pep-561
Vorherrschende Sprache
Python
Sterne
20.6k
Forks
3.3k
PR-Merge-Kennzahlen
PR-Kennzahlen ausstehend

Beschreibung

Documentation

https://mypy.readthedocs.io/en/stable/installed_packages.html#creating-pep-561-compatible-packages as noted in https://github.com/pypa/hatch/discussions/554 only mentions setup.py which is deprecated for simply defining metadata, see PEP 621

It would be nice to mention the Hatchling way as that is now the default in the official Python packaging tutorial.

Beitragsleitfaden

Beitragsleitfaden öffnen

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

Beginne mit dem Abschnitt „Creating PEP 561-compatible packages“ auf der verlinkten mypy-Dokumentationsseite und lies anschließend die verlinkte PEP 621, die Hatchling-Diskussion und das Python packaging tutorial. Aktualisiere die Beispiele, sodass neben oder anstelle von setup.py der moderne Hatchling- und Metadatenansatz erwähnt wird, und überprüfe, dass die Dokumentation die aktuellen Empfehlungen für das Packaging korrekt wiedergibt.

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

Neue Issues direkt in Ihr Postfach

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