Qu'est-ce qui doit être dans un paquet Python et comment doit-il être structuré?

Question

J'ai un projet Python que je suis prêt à emballer. Je n'ai jamais créé de paquet de code auparavant et je n'ai aucune idée de ce qui est impliqué. En ce moment, mon projet ressemble à ceci:

Project/ 
    bin/ 
     script1.py 
     script2.py 
     script3.py 
    project/ 
     __init__.py 
     module1.py 
     module2.py 
     module3.py 
    folder_where_files_created_by_the_scripts_go/ 
    BeautifulSoup/ 
     [stuff] 

Je sais que je dois créer un fichier setup.py, un README, je me souviens avoir lu quelque part que bin/est l'endroit où vous êtes censé stocker des scripts qui exécutent les modules ... Je suis sûr qu'il y en a beaucoup plus que j'oublie ou que je ne connais pas pour commencer. Fondamentalement, je cherche un tutoriel qui suppose que je ne sais absolument rien sur le code du paquet et tiendra ma main à travers tout le processus d'écrire le README et l'installation pour me dire quels répertoires il devrait être et ce qui devrait être dans eux. Tout ce que j'ai trouvé par googling est essentiellement un article "Comment faire de meilleurs paquets" qui commence à un niveau élevé.

En outre, si cela fait une différence, ce projet est pour un professeur d'affaires qui avait besoin d'une certaine tâche à remplir; pour l'instant, je n'ai pas l'intention de le télécharger sur PyPI, mais je pourrais le vouloir dans le futur, et je voudrais faire les choses correctement maintenant pour me sauver les tracas futurs.

Answer 1

Après plus googling j'ai trouvé un bon tutoriel: http://www.scotttorborg.com/python-packaging/index.html

Espérons que cela aide quelqu'un d'autre avec le même manque total de connaissances dans ce domaine.