New Empty Python Project Base

Nouvelle base de projet Python vide

C'est exactement ce dont vous avez besoin pour démarrer un nouveau projet Python.

Utilisez simplement ce modèle de projet pour démarrer de nouveaux projets Python.

En utilisant ce modèle pour votre projet (comment faire)

Vous pouvez désormais créer automatiquement un nouveau projet basé sur ce modèle en cliquant ici sur Use this template , ou en cliquant sur le bouton ci-dessus dans le référentiel, comme illustré dans l'image ci-dessous. Si vous n'utilisez pas GitHub, vous pouvez aussi bien cloner ce référentiel.

L'adapter à votre propre projet

1. Renommez le project/ dossier (et toutes les références à ce dossier dans d'autres fichiers) pour personnaliser le nom de votre projet qui est actuellement nommé project selon le nom du dossier.
2. Vous pouvez exécuter des tests en exécutant pytest dans la racine ou en exécutant python3 setup.py test . La couverture du code est activée avec PyTest-CoV.
3. Modifiez la setup.py de votre projet pour le faire vraiment le vôtre. Supprimez mon e-mail et mes informations d'ici et mettez vos propres informations. Vous pouvez également supprimer le fichier setup.py complet au lieu de l'adapter si vous n'avez pas l'intention de publier votre projet sur pip ni sur conda en tant que package.
4. Commencez à coder dans votre dossier de projet maintenant renommé et ajoutez quelques tests supplémentaires dans le testing/ dossier!

Si la construction d'un package: déploiement de votre nouveau package à PYPI

Téléchargez votre projet en tant que package sur PYPI, l'index Python Package, pour le rendre disponible sur pip ! (facultatif)

Pour ce faire, lisez mon court guide étape par étape sur la façon de déployer un nouveau package (ou une version du package) sur PYPI.

Si la création d'une application API REST (par exemple: SaaS): structurer les couches de votre architecture logicielle

J'ai enregistré ici mes conseils et astuces, ce qu'il faut rechercher et comment structurer votre application pour qu'elle soit propre en termes d'architecture logicielle: https://youtu.be/k4qn27ikr0g?t=1211

Comprendre comment ce modèle fonctionne

L'article The Optimal Python Project Structure de Luke Tonin fait un bon travail pour expliquer comment un modèle comme le présent fonctionne. Le modèle actuel est un peu plus complet et complexe que dans l'article, pensait, car il comprend déjà une suite de tests (y compris un exemple de test de démarrage), et un fichier setup.py complet pour que votre projet soit correctement emballé.

Il y a aussi ma vidéo sur l'architecture de logiciels qui peut aider, dans laquelle je fais l'aperçu d'un projet complet basé sur ce modèle, en termes d'architecture logicielle théorique plutôt que de pratiquer comment utiliser le modèle.

Licence

Dans la mesure du possible en vertu de la loi, Guillaume Chevalier et Neuraxio Inc. ont renoncé à tous les droits d'auteur et aux droits connexes ou voisins sur ce travail.

Les citations qui sont liées à ce référentiel seront appréciées, mais ne sont pas nécessaires.