pypa / pypa/packaging.python.org
Clarify that Packaging Tutorial is for importable modules
Dieses Issue hat noch niemand übernommen.
- Vorherrschende Sprache
- Python
- Sterne
- 1.7k
- Forks
- 1.7k
- Ø Merge
- 3 T. 12 Std.
- Gemergte PRs (30 T.)
- 4
Beschreibung
Following-up from a discussion with @ncoghlan at the PyCon 2019 packaging sprint, re: https://packaging.python.org/tutorials/packaging-projects/
I have a simple executable script that I run on the command line as python my_utility.py. I'd rather run it as my_utility. The tutorial doesn't cover entry_points. I don't necessarily think it should, but I think it'd be helpful to make that a clear distinction, possibly with links to relevant next steps.
entry_points is discussed in the packaging and distributing guide, and used in the sample project.
Beitragsleitfaden
Für dieses Repository ist kein Beitragsleitfaden indexiert
Erste Schritte
- Lies das ganze Issue und danach den Beitragsleitfaden des Projekts.
- Schreib ins Issue, dass du es übernimmst — das erspart doppelte Arbeit.
- Forke das Repository und arbeite in einem Branch.
- Öffne einen Pull Request, der die Issue-Nummer nennt.
Rechercherichtung
Beginne mit dem Packaging Tutorial unter https://packaging.python.org/tutorials/packaging-projects/ und vergleiche seinen Umfang mit dem verlinkten Leitfaden zu entry points und dem Beispielprojekt. Stelle klar, dass das Tutorial auf importierbare Module abzielt, und füge Links oder Hinweise zu den nächsten Schritten für ausführbare Skripte hinzu; das Tutorial sollte diese Unterscheidung ausdrücklich machen.
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
- Größtenteils klar
- Anfängerfreundlichkeit
- 45/100