4.6 KiB
Minor swing with Django
On ne va pas se mentir: il existe enormément de tutoriaux très bien réalisés sur "Comment réaliser une application Django" et autres "Déployer votre code en 2 minutes". On se disait juste que ces tutoriaux restaient relativement haut-niveau et se limitaient à un contexte donné.
L’idée du texte ci-dessous est de jeter les bases d’un bon développement, en survolant l’ensemble des outils permettant de suivre des lignes directrices reconnues, de maintenir une bonne qualité de code au travers des différentes étapes (du développement au déploiement) et de s’assurer du maintient correct de la base de code, en permettant à n’importe qui de reprendre le développement.
Ces idées ne s’appliquent pas uniquement à Django et à son cadre de travail, ni même au langage Python. Juste que ces deux bidules sont de bons candidats et que le cadre de travail est bien défini et suffisamment flexible.
Django se présente comme un "Framework Web pour perfectionnistes ayant des deadlines" et suit ces quelques principes:
-
Faible couplage et forte cohésion, pour que chaque composant ait son indépendance.
-
Moins de code, plus de fonctionnalités.
-
Don’t repeat yourself: on ne se répète pas !
-
Rapidité du développement (après une petite courbe d’apprentissage un peu ardue au début ;-))
Mis côte à côte, l’application de ces principes permet une meilleure stabilité du projet à moyen et long terme. Tout pour plaire à n’importe quel directeur IT.
Dans la première partie, on verra comment configurer l’environnement, comment installer Django de manière isolée et comment démarrer un nouveau projet. On verra comment gérer correctement les dépendances, les versions et comment appliquer et suivre un score sur note code. On verra aussi que la configuration proposée par défaut par le framework n’est pas idéale dans la majorité des cas.
Pour cela, on présentera différents outils (mypy, flake8, black, …), la rédaction de tests unitaires et d’intégration pour limiter les régressions, les règles de nomenclature et de contrôle du contenu, ainsi que les bonnes étapes à suivre pour arriver à un déploiement rapide et fonctionnel avec peu d’efforts.
Dans la deuxième partie, on détaillera précisément les étapes de déploiement, avec la description et la configuration de l’infrastructure, des exemples concrets de déploiement sur deux distributions principales (Debian et CentOS), ainsi que l’utilisation de Docker et Docker-Compose.
On abordera également la supervision et la mise à jour d’une application existante, en respectant les bonnes pratiques d’administration système.
Dans la troisième partie, on abordera les grands principes de modélisation, en suivant les lignes de conduites du cadre de travail. On abordera les concepts clés qui permettent à une application de rester maintenable, les formulaires et leurs validations, les migrations de données et l’administration.
Dans la quatrième partie, on mettra ces concepts en pratique en présentant le développement d’une "vraie" application: définition des tables, gestion des utilisateurs, … et mise à disposition!
Et tout ça à un seul et même endroit. Oui. :-)
Bonne lecture.
Unresolved directive in <stdin> - include::part-1-workspace/00-main.adoc[]
Unresolved directive in <stdin> - include::part-2-deployment/00-main.adoc[]
Unresolved directive in <stdin> - include::part-3-django-concepts/00-main.adoc[]
Go Live !
Pour commencer, nous allons nous concentrer sur la création d’un site ne contenant qu’une seule application, même si en pratique le site contiendra déjà plusieurs applications fournies pas django, comme nous le verrons plus loin.
Pour prendre un exemple concret, nous allons créer un site permettant de gérer des listes de souhaits, que nous appellerons gwift (pour GiFTs and WIshlisTs :)).
La première chose à faire est de définir nos besoins du point de vue de l’utilisateur, c’est-à-dire ce que nous souhaitons qu’un utilisateur puisse faire avec l’application.
Ensuite, nous pourrons traduire ces besoins en fonctionnalités et finalement effectuer le développement
Unresolved directive in <stdin> - include::gwift/specs.adoc[]
Unresolved directive in <stdin> - include::gwift/models.adoc[]
Unresolved directive in <stdin> - include::gwift/tests.adoc[]
Unresolved directive in <stdin> - include::gwift/key-points.adoc[]
Unresolved directive in <stdin> - include::gwift/refactoring.adoc[]
Unresolved directive in <stdin> - include::gwift/user-management.adoc[]
Unresolved directive in <stdin> - include::gwift/console.adoc[]