Clarification on Sample Repository Structure

Ouverte
#983 0 commentaires 0 réactions 0 personnes assignées Voir sur GitHub

Personne n'a encore pris cette issue.

Évaluation

Difficulté
4/5
Temps estimé
3-5 jours
Accessibilité débutants
35/100
Type d'issue
Documentation
Clarté
Plutôt claire
Activité
À l'abandon
Stack technique
python
Domaine
documentation

Piste de recherche

Commencez par la section Sample Repository à l’adresse /writing/structure/ et lisez les indications environnantes sur setup.py, requirements.txt, Pipfile, virtualenv, context.py et Makefile. Comparez la structure du projet et le workflow décrits, puis identifiez les explications ou les liens qui nécessitent des éclaircissements. Le travail est considéré comme terminé lorsque la section explique de manière cohérente ses recommandations, ses alternatives et le rôle de chaque fichier nommé.

Rédigé par le modèle d'indexation à partir du texte de l'issue.

Description

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?
Langage dominant
Batchfile
Étoiles
29.8k
Forks
5.9k
Aucune PR mergée en 30 j

Guide de contribution

Ouvrir le guide de contribution

Par où commencer

  1. Lisez l'issue en entier, puis le guide de contribution du projet.
  2. Signalez en commentaire que vous la prenez — cela évite que deux personnes fassent le même travail.
  3. Forkez le dépôt et travaillez sur une branche.
  4. Ouvrez une pull request qui référence le numéro de l'issue.

Autres issues de realpython/python-guide

Toutes les issues de realpython/python-guide

Issues similaires

Plus d'issues Documentation

Recevez les nouvelles issues par e-mail

Un résumé court des issues GitHub adaptées aux débutants.