Rendre votre projet Python Flask installable

Introduction

Dans ce laboratoire, nous allons apprendre à rendre un projet Python Flask installable. Cela permettra de déployer et de gérer le projet à l'aide d'outils Python standards. Ce processus est bénéfique car il permet d'installer le projet dans différents environnements, de gérer les dépendances et d'isoler les environnements de test.

Note : Vous devez créer le fichier de code vous-même et l'exécuter dans l'environnement. Vous pouvez prévisualiser l'état du service Flask sur le Web 5000.

Skills Graph

%%%%{init: {'theme':'neutral'}}%%%% flowchart RL flask(("Flask")) -.-> flask/DataHandlingGroup(["Data Handling"]) flask(("Flask")) -.-> flask/CoreConceptsGroup(["Core Concepts"]) flask(("Flask")) -.-> flask/DevelopmentToolsGroup(["Development Tools"]) flask/DataHandlingGroup -.-> flask/incoming_request_data("Incoming Request Data") flask/DataHandlingGroup -.-> flask/response_objects("Response Objects") flask/CoreConceptsGroup -.-> flask/application_object("Application Object") flask/DevelopmentToolsGroup -.-> flask/command_line_interface("Command Line Interface") subgraph Lab Skills flask/incoming_request_data -.-> lab-136341{{"Rendre le projet installable"}} flask/response_objects -.-> lab-136341{{"Rendre le projet installable"}} flask/application_object -.-> lab-136341{{"Rendre le projet installable"}} flask/command_line_interface -.-> lab-136341{{"Rendre le projet installable"}} end

Décris le projet

Tout d'abord, nous devons créer un fichier pyproject.toml pour décrire notre projet et la manière de le construire.

Le fichier pyproject.toml devrait ressembler à ceci :

## pyproject.toml

[project]
name = "flaskr" ## nom du projet
version = "1.0.0" ## version du projet
dependencies = [
    "flask", ## dépendances du projet
]

[build-system]
requires = ["setuptools"] ## système de build requis
build-backend = "setuptools.build_meta" ## système de build de fond

Inclut les fichiers nécessaires

Le build backend de setuptools a besoin d'un autre fichier nommé MANIFEST.in pour inclure les fichiers non-Python dans le projet.

Crée un MANIFEST.in avec le contenu suivant :

## MANIFEST.in

include flaskr/schema.sql
graft flaskr/static
graft flaskr/templates
global-exclude *.pyc

Cela indique au build de copier tout ce qui se trouve dans les répertoires static et templates, ainsi que le fichier schema.sql, tout en excluant tous les fichiers de bytecode.

Installe le projet

Ensuite, nous allons utiliser pip pour installer le projet dans l'environnement virtuel.

Exécutez la commande suivante dans votre terminal :

pip install -e.

Cela indique à pip de trouver pyproject.toml dans le répertoire actuel et d'installer le projet en mode éditable ou de développement. Le mode éditable signifie que lorsque vous apportez des modifications à votre code local, vous n'aurez besoin de réinstaller que si vous modifiez les métadonnées du projet.

Pour vérifier l'installation, utilisez la commande pip list :

pip list

La sortie devrait montrer le projet installé et ses dépendances.

Sommaire

Dans ce laboratoire, nous avons appris à rendre un projet Python Flask installable. Nous avons commencé par décrire le projet et inclure les fichiers nécessaires. Nous avons ensuite installé le projet dans un environnement virtuel. Maintenant, le projet peut être exécuté à partir de n'importe quel emplacement, pas seulement du répertoire du projet.