1. A propos du fichier requirements.txt
Le fichier requirements.txt est un fichier texte utilisé dans le contexte de projets Django (et plus généralement en Python) pour spécifier les dépendances du projet, c'est-à-dire les bibliothèques externes nécessaires au bon fonctionnement de l'application. Le fichier requirements.txt est un moyen de documenter et de gérer les dépendances d'un projet Django, facilitant ainsi le partage et le déploiement cohérent du projet entre différents environnements.
2. Principales caractéristiques du fichier requirements.txt
Nom du fichier : Le fichier doit être nommé requirements.txt et être situé à la racine du projet Django.
Liste des Dépendances : Le fichier contient une liste des bibliothèques Python nécessaires au projet, chaque bibliothèque étant spécifiée avec son nom suivi éventuellement d'une version.
Exemple
|
1 2 |
Django==4.1.3 requests==2.21.0 |
Dans cet exemple, le projet dépend de Django en version 4.1.3 et de Requests en version 2.21.0.
Versions des Dépendances : Vous pouvez spécifier des versions précises des bibliothèques pour assurer la stabilité de votre projet. Cela peut être fait en utilisant des opérateurs de comparaison comme ==, >=, <=, etc.
Exemple
|
1 |
Django>=3.1,<4.3 |
Cela signifie que le projet nécessite une version de Django égale ou supérieure à la version 3.1, mais inférieure à 4.3.
3. Installation des Dépendances requirements.txt
Installation des dépendances citées dans le fichiers requirements.txt
Pour installer les dépendances répertoriées dans le fichier requirements.txt, vous pouvez utiliser la commande:
|
1 |
pip install -r requirements.txt |
Cette commande installera toutes les bibliothèques répertoriées avec les versions spécifiées.
Gestion des Environnements Virtuels : Il est généralement recommandé d'utiliser un environnement virtuel pour isoler les dépendances de chaque projet Django. Cela garantit que les versions spécifiques des bibliothèques requises par un projet n'interfèrent pas avec d'autres projets.
Exemple
|
1 2 3 |
python -m venv venv source venv/bin/activate # Pour Linux/Mac pip install -r requirements.txt |
4. Créer un fichier requirements.txt pour votre projet
Vous avez crée un projet django ou plus généralement un projet Python et vous vous demandez comment créer le fichier des dépendances requirements.txt automatiquement! Et bien le problème est simple! Il suffit d'activer votre environnement virtuel et d'utiliser pip freeze:
Exécuter la commande suivante à la racine de votre projet:
|
1 |
pip freeze > requirements.txt |
Remarque
Vous pouvez aussi utiliser pipenv
vous pouvez également utiliser la commande pipenv lock -r > requirements.txt pour générer le fichier requirements.txt à partir du Pipfile.lock.
|
1 |
pipenv lock -r > requirements.txt |
Ces méthodes devraient vous permettre de générer un fichier requirements.txt complet qui inclut toutes les dépendances de votre projet.
NB: il est nécessaire de vérifier le fichier généré pour vous assurer qu'il contient toutes les dépendances nécessaires, faute de quoi, votre projet sera inpartageable et inutilisable par d'autres développeurs.
Younes Derfoufi
CRMEF OUJDA
