Où dois-je placer la démo script d'un paquetage Python ?

Question

Je suis en train de coder un nouveau paquet python qui sera utilisé par d'autres. Pour démontrer comment il devrait être utilisé, j'écris un script de démonstration qui exécute les principales parties du nouveau paquet.

Quelle est la convention à respecter pour que les autres trouvent facilement le script ? Devrait-il s'agir d'un module séparé (avec quel nom) ? Doit-il être situé dans le répertoire racine du paquetage ? En dehors du paquet ? Dans __init__.py ?

Answer 1

Je n'ai jamais vu de véritable convention à ce sujet, mais je l'ai personnellement placé dans une sentinelle principale à l'intérieur de l'enceinte de l'entreprise. __init__.py afin qu'il puisse être invoqué via python -m somepackage .

Answer 2

Doit-il s'agir d'un module distinct (sous quel nom) ?

demo/quelque_nom_utile.py

Un répertoire démo contient des scripts. De même, un répertoire test contient tous vos tests unitaires.

Doit-il être situé dans le répertoire Root du paquet ?

Non. Il ne fait pas partie du paquet. C'est une démo.

En dehors de l'emballage ?

Oui.

En init .py ?

Jamais.

---

Un paquet a deux vies. (1) en tant que source désinstallée, (2) dans la lib/site-packages en tant que code installé.

La "source" doit inclure README, setup.py, le répertoire demo, le répertoire test, et le paquet lui-même.

Le fichier setup.py de niveau supérieur "source" ne devrait installer que le paquetage. La démo et le test ne sont pas installés. Ils sont laissés sur place dans le cadre du téléchargement.