realpython / realpython/python-guide

Clarification on Sample Repository Structure

Offen
#983 0 Kommentare 0 Reaktionen 0 zugewiesene Personen Auf GitHub ansehen

Dieses Issue hat noch niemand übernommen.

Vorherrschende Sprache
Batchfile
Sterne
29.8k
Forks
5.9k
PR-Merge-Kennzahlen
Keine gemergten PRs in 30 T.

Beschreibung

In Structuring Your Project (/writing/structure/) the section Sample Repository is a little confusing (at least for me).

  1. Stating that this is the way Kenneth Reitz recommends structuring a project is a little confusing. Is there another way? (I'm sure there are) If so, is Reitz's way the de facto standard or is there another standard out there? (Perhaps links to some other popular structures would be helpful)
  2. On the same vein as 1 above, in most areas the guide is opinionated but in this section by stating its the way Reitz does it, it becomes very unopinionated and this sticks out. Does this mean that the authors aren't agreed upon Reitz's methodology?
  3. We haven't talked about setup.py up to this point in the guide. What is it? (https://stackoverflow.com/questions/1471994/what-is-setup-py)
  4. Here it is suggested we use requirements.txt although earlier we are encouraged to use pipenv and its pipfile (although we are also shown how to use virtualenv directly), this is a bit confusing as there is no mention of a pipfile at all. Might be helpful to expand to include some notes on the pipfile and whether we should include both or one over the other.
  5. The suggested project structure doesn't include context.py, but this seems to be as much a core part as the rest of the test files - should this be added?
  6. The section on Makefile is also confusing - there is no reference to Makefile in the initial project structure; when exactly might one use this?

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 Sample Repository unter /writing/structure/ und lies die umgebenden Hinweise zu setup.py, requirements.txt, Pipfile, virtualenv, context.py und Makefile. Vergleiche die beschriebene Projektstruktur und den Workflow und ermittle anschließend, welche Erklärungen oder Links einer Klarstellung bedürfen. Als erledigt gilt die Aufgabe, wenn der Abschnitt seine Empfehlungen, Alternativen und die Rolle jeder genannten Datei konsistent erklärt.

Vom Indexierungsmodell aus dem Issue-Text verfasst.

Bewertung

Tech-Stack
python
Bereich
documentation
Issue-Typ
Dokumentation
Schwierigkeit
4/5
Geschätzter Aufwand
3-5 Tage
Aktivitätsstatus
Veraltet
Klarheit
Größtenteils klar
Anfängerfreundlichkeit
35/100

Neue Issues direkt in Ihr Postfach

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