API Flask en Python pour récupérer les données de la base Notion de Cemantix/Cemantle.
Retrouve le code sur le repo --> ici
ℹ️ Avertissement : j'ai fait ce projet pour apprendre les bases de Flask, alors n'hésite pas à me faire tes retours
API Flask pour les statistiques de Cemantix
On va explorer l'implémentation d'une API Flask qui récupère et fournit les statistiques de l'application Cemantix. L'API interagit avec une base de données Notion pour récupérer les données utiles et les expose dans un format structuré.
Introduction
L'API Flask sert d'interface pour récupérer les statistiques liées à l'application Cemantix. L'application Cemantix s'appuie sur la plateforme Notion pour stocker et gérer ses données. Grâce à l'API Notion, l'API Flask interagit avec la base de données Notion de Cemantix pour récupérer des informations comme le mot du jour, le temps écoulé, le nombre de requêtes et la date associée aux statistiques.
Dépendances
Avant de lancer l'API Flask, vérifie que les dépendances suivantes sont bien installées :
- Python 3.x : le langage de programmation utilisé pour l'API Flask.
- pip : le gestionnaire de paquets de Python.
- Environnement virtuel (optionnel) : recommandé pour gérer les dépendances du projet.
Pour installer les dépendances nécessaires, suis ces étapes :
- Mettre en place un environnement virtuel (optionnel) : il est recommandé de créer un environnement virtuel pour isoler les dépendances du projet. Tu peux en créer un avec
venvouconda. Voici un exemple avecvenv:
python3 -m venv myenv
source myenv/bin/activate- Installer les dépendances : dans le dossier du projet, lance la commande suivante pour installer les paquets nécessaires :
pip install -r requirements.txtCette commande installe Flask, Flask-Cors, requests et python-dotenv dans leurs versions spécifiées.
Endpoints de l'API
L'API Flask expose un seul endpoint / qui renvoie les statistiques de Cemantix au format JSON. Jetons un œil au code :
@app.route('/')
def get_stats():
return jsonify(build_stats()), 200La fonction get_stats est décorée avec @app.route('/'), ce qui signifie qu'elle gère les requêtes vers l'URL racine de l'API. Quand une requête arrive sur cet endpoint, la fonction build_stats est appelée pour récupérer les statistiques de Cemantix, qui sont ensuite renvoyées sous forme de réponse JSON.
La fonction build_stats se charge de récupérer les données depuis la base de données Notion de Cemantix. Elle utilise les tokens Notion et les IDs de base de données fournis pour envoyer des requêtes authentifiées à l'API Notion. Les données récupérées sont ensuite traitées et organisées dans un dictionnaire contenant les statistiques des deux sections "cemantix" et "cemantle".
Récupérer les données de Cemantix
Pour récupérer les données de la base de données Notion de Cemantix, l'API Flask utilise la fonction fetch_cemantix_data. Cette fonction prend en paramètres un token et un ID de base de données, et envoie une requête POST à l'API Notion avec le payload indiqué. La réponse est renvoyée pour être traitée ensuite.
L'API Flask fournit plusieurs fonctions utilitaires pour extraire des informations précises des données récupérées :
retrieve_word_of_the_day: récupère le mot du jour à partir des données récupérées.retrieve_elapsed_time: récupère le temps écoulé à partir des données récupérées.retrieve_requests_number: récupère le nombre de requêtes à partir des données récupérées.retrieve_word_date: récupère la date associée aux statistiques à partir des données récupérées.
Ces fonctions accèdent aux propriétés concernées dans la réponse JSON et en extraient les informations nécessaires.
Cross-Origin Resource Sharing (CORS)
Pour autoriser les requêtes venant d'origines précises, l'API Flask utilise l'extension Flask-Cors. La fonction CORS est appelée avec le paramètre origins, qui définit les origines autorisées. Ici, les requêtes venant de http://localhost:5173 et de https://cemantix-ui.vercel.app sont autorisées.
Lancer l'API
Pour lancer l'API Flask, vérifie que les dépendances nécessaires sont installées. Crée un fichier .env dans le même dossier que le script de l'API Flask et renseigne les variables d'environnement nécessaires :
CEMANTIX_NOTION_TOKEN=<your_cemantix_notion_token>
CEMANTIX_DATABASE_ID=<your_cemantix_database_id>
CEMANTLE_NOTION_TOKEN=<your_cemantle_notion_token>
CEMANTLE_DATABASE_ID=<your_cemantle_database_id>Remplace <your_cemantix_notion_token>, <your_cemantix_database_id>, <your_cemantle_notion_token> et <your_cemantle_database_id> par les valeurs correspondantes.
Une fois les variables d'environnement définies, lance le script de l'API Flask. L'API sera accessible sur http://localhost:5000/. Envoie une requête GET à cette URL pour récupérer les statistiques de Cemantix au format JSON.
Conclusion
L'API Flask présentée ici offre un moyen pratique de récupérer les statistiques de l'application Cemantix. En s'appuyant sur l'API Notion et sur la simplicité de Flask, l'API interagit avec la base de données Notion et expose les statistiques dans un format structuré. Différents clients peuvent utiliser cette API pour accéder aux statistiques de Cemantix et les exploiter pour des analyses ou des visualisations.
