Construire un framework au-dessus de FastAPI, Alembic & SQLAlchemy

Photo by Dstudio Bcn on Unsplash

Cette idée est née après avoir recherché un moyen de créer le backend pour un projet personnel. FastAPI a été choisi, due au fait qu’il permettait de construire une API prête à l’usage en peu de ligne de codes. Il offrait aussi, le typage des réponses et des paramètres pour les routes sans nécessité d’installer des packages additionnels.

Auparavant, j'utilisais Django qui est très bien pour construire des applications, des API et bien d’autres usages. Cependant, il arrive que l’ORM n’optimise pas toutes les requêtes sur la base de donnée, ce qui rend les opérations très lourdes à exécuter.

Le choix de FastAPI a été fait après avoir parcouru plusieurs sous forums Reddit qui discutait sur des alternatives à Django. Ils recommandaient aussi SQLAlchemy comme ORM et son petit frère Alembic pour la gestion des migrations.

Néanmoins, la plupart des tutoriels YouTube qui montraient comment créer un projet FastAPI ne montraient que comment créer un projet FastAPI avec qu’un seul fichier python. Ce qui est bien pratique quand on débute, mais lorsqu’on pense à déployer en production, cette architecture n’est pas pratique.

Alors après avoir suivi une autre vidéo YouTube mentionnant ce problème, il avait été recommandé de prendre exemple sur le répertoire dispatch de Netflix qui utilisait une version modifiée de fastapi.

GitHub - Netflix/dispatch: All of the ad-hoc things you're doing to manage incidents today, done…

Dans l’optique d’avoir une structure production-ready, je me suis inspirée de ce dernier pour restructurer d’une meilleure manière mon projet, et intégrer des mécanismes proches de ce que Django que proposait par défaut ( un mécanisme de boilerplate pour créer une application dans mon projet, un mécanisme pour créer et migrer mes modèles de base de données ).

L’architecture du projet est présentée ci-dessous :

architecture du projet

  -- albic : Configuration folder of Alembic for SQLAlchemy ( env.py and migrations ),
  -- apps  : Core Folder of the app
      -- app_names.py : provide custom app folder to use for db migration.
      -- db.py : configure the sqlalchemy interface for the app,
      -- env.py : configure the .env to load for the app,
      -- init.py : override the venv source folder to force it to run from src folder,
      -- run.py : load routers and create the app instance for fastapi
  -- command : Utilities to create quickly a fast api app
      -- create_app.py : similar to django startapp, he copies template from conf/app_template and
      create app with the name given
      -- abs_create_app.py : functions needed by create_app.py
      -- conf : template used by the command
  -- requirements : requirements to run this project
  -- templates : used by jinja to serve pages
  -- tests : write tests here
  alembic.ini : alembic config file to start the project
  manage.py   : entrypoint to start the project, migrate the database, create a app into the project.peacher : Fast API app
  -- albic : Configuration folder of Alembic for SQLAlchemy ( env.py and migrations ),
  -- apps  : Core Folder of the app
      -- app_names.py : provide custom app folder to use for db migration.
      -- db.py : configure the sqlalchemy interface for the app,
      -- env.py : configure the .env to load for the app,
      -- init.py : override the venv source folder,
      -- run.py : load routers and create the app instance for fastapi
  -- command : Utilities to create quickly a fast api app
      -- create_app.py : similar to django startapp, he copies template from conf/app_template and
      create app with the name given
      -- abs_create_app.py : functions needed by create_app.py
      -- conf : template used by the command
  -- requirements : requirements to run this project
  -- templates : used by jinja to serve pages
  -- tests : write tests here
  alembic.ini : alembic config file to start the project
  manage.py   : entrypoint to start the project, migrate the database, create a app into the project

Lien vers le projet :

Home Script / Peacher · GitLab

Le script de démarrage est le fichier manage.py, il est très similaire à celui de Django et propose actuellement 3 commandes :

• start_server : il démarre le serveur pour accéder a l’application en production et en développement. Je l’ai testé actuellement sur render.com. Pour pouvoir le faire tourner sur les autres fournisseurs, cela va nécessiter des configurations additionnelles
• migrate_db : il lance le mécanisme de migration de la base de donnée et versionne-les différents changements,
• create_app : vous permet de créer une petite application avec un nom qui vous auriez fourni. Si par exemple votre application se nomme utilisateurs, la structure de votre projet sera la suivante :

structure for app

Je vous remercie d’avoir lu cet article et aimerais que vous le partagiez à vos collègues ou votre équipe technique que cela intéresserait.

Ne manquez pas d’applaudir et de suivre l’auteur ️👏️️

Suivez-moi sur les réseaux sociaux : X | LinkedIn | GitHub

Visiter les projets perso que je conçois : Homescript | Tiyalo | Houegbe | Shokays