Installation

Installer Flask-Jeroboam

Je publie Flask-Jeroboam sur PyPI, l’index des paquets Python, et en tant que tel, il est facilement installable en utilisant l’une des commandes suivantes, selon votre outil de gestion des dépendances:

$ poetry add flask-jeroboam

Avec cette commande, vous avez installé Flask-Jeroboam avec ses deux dépendances directes, Flask et Pydantic ainsi que leur propre arbre de dépendances (consultez-le ici).

Note

Nous recommandons fortement d’installer Flask-Jeroboam dans un environnement virtuel. Si vous avez besoin de directives sur la façon de procéder, consultez la section Configuration de l’Environnement de notre tutoriel pour plus d’informations.

Dépendances

L’installation de Flask-Jeroboam installera automatiquement ces paquets avec leurs dépendances:

  • Flask le gros du travail du framework web est toujours effectué par Flask.

  • Pydantic pour fournir la validation des données en utilisant les annotations de type Python.

Ces deux dépendances directes viennent avec leur propre arbre de dépendances. Au total, vous aurez jusqu’à 9 nouveaux paquets installés. Il existe une belle commande poetry pour explorer cet arbre. Voici comment:

$ poetry show flask-jeroboam --tree
flask-jeroboam 0.1.0b0 Une extension Flask, inspirée de FastAPI qui utilise Pydantic pour fournir une validation des données facile à configurer pour l'analyse des requêtes et la sérialisation des réponses.
├── flask >=2.1.3,<3.0.0
│   ├── click >=8.0
│   │   └── colorama *
│   ├── itsdangerous >=2.0
│   ├── jinja2 >=3.0
│   │   └── markupsafe >=2.0
│   └── werkzeug >=2.2.2
│       └── markupsafe >=2.1.1 (dépendance circulaire interrompue ici)
└── pydantic >=1.10.2,<2.0.0
   └── typing-extensions >=4.2.0

Tester votre installation

Assurons-nous que vous avez tout configuré correctement. Créez et ouvrez un fichier simple à la racine de votre projet: app.py.

 1
 2from flask_jeroboam import Jeroboam
 3
 4app = Jeroboam(__name__)
 5
 6
 7@app.get("/ping")
 8def ping():
 9    return "pong"
10
11
12if __name__ == "__main__":
13    app.run(port=5000)

L’exécution de ce fichier devrait démarrer un serveur sur localhost:5000. Vous pouvez appeler cet endpoint avec la commande curl 'http://localhost:5000/ping' ou directement dans votre navigateur en allant sur http://localhost:5000/ping. Si l’un ou l’autre répond “pong”, votre installation est fonctionnelle, et vous êtes prêt à passer à notre Guide de Démarrage.

Dépannage

Problèmes d’Installation Courants

Erreur d’importation: Aucun module nommé ‘flask_jeroboam’

Si vous rencontrez cette erreur après l’installation, assurez-vous que:

  1. Vous utilisez le bon environnement Python (activez votre environnement virtuel)

  2. Le paquet a été installé dans l’environnement actif: pip list | grep flask-jeroboam

  3. Vous utilisez la bonne instruction d’importation: from flask_jeroboam import Jeroboam

Conflits de Version

Si vous rencontrez des conflits de version avec Flask ou Pydantic:

  1. Vérifiez vos versions actuelles: pip show flask pydantic

  2. Assurez-vous que Flask >= 2.1.3 et Pydantic >= 1.10.2, < 2.0.0

  3. Envisagez d’utiliser un nouvel environnement virtuel pour isoler les dépendances

Problèmes d’Environnement Virtuel

Si les paquets ne sont pas trouvés malgré l’installation:

$ python -m venv venv
$ source venv/bin/activate  # Sur Windows: venv\Scripts\activate
$ pip install flask-jeroboam

Désinstaller Flask-Jeroboam

Retirer Flask-Jeroboam des dépendances de votre projet est aussi simple que de l’ajouter à votre projet:

$ poetry remove flask-jeroboam