pypa / pypa/packaging.python.org

Explain clearly that python / pip / other commands are not Python code

Offen
#745 2 Kommentare 1 Reaktion 0 zugewiesene Personen Auf GitHub ansehen

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

https://github.com/pypa/packaging-problems/issues/369 is the latest instance of a person trying to type python setup.py sdist or pip install something in the Python shell rather than in a system console, which is not obvious to everyone.

None of https://packaging.python.org/tutorials/packaging-projects and https://packaging.python.org/guides/distributing-packages-using-setuptools/#wheels say a word about that.

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

Beginne mit dem Lesen des Tutorials „Packaging Projects“ und des Leitfadenabschnitts zum Verteilen von Paketen mit setuptools, insbesondere der darin enthaltenen Befehlsbeispiele. Füge einen klaren Hinweis hinzu, der Befehle wie python setup.py sdist und pip install something von Python-Code unterscheidet und erklärt, dass sie in eine Systemkonsole gehören; bestätige, dass beide referenzierten Seiten diese Klarstellung enthalten.

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

Neue Issues direkt in Ihr Postfach

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