From e0b314ee76315ecd2a7fe3cb8e8a9e5dbfadbc12 Mon Sep 17 00:00:00 2001 From: anthonycoyaud-prog Date: Wed, 20 May 2026 11:18:09 +0200 Subject: [PATCH] changement readme --- README.md | 35 ++++++++++++++++++++++++++++++++++- requirements.txt | 4 ++++ 2 files changed, 38 insertions(+), 1 deletion(-) create mode 100644 requirements.txt diff --git a/README.md b/README.md index beab128..f8d5445 100644 --- a/README.md +++ b/README.md @@ -1 +1,34 @@ -# Api-DataSentinel \ No newline at end of file +# Api-DataSentinel + +API FastAPI pour Data Sentinel. + +## Installation + +1. Ouvrir un terminal dans le dossier du projet : + ```powershell + cd "c:\Users\antho\Desktop\Projet de fin d'année\Projet fin d_année\DataSentinel\Api-DataSentinel" + ``` +2. Créer et activer l'environnement virtuel (si nécessaire) : + ```powershell + python -m venv .venv + .\.venv\Scripts\Activate.ps1 + ``` +3. Installer les dépendances : + ```powershell + pip install -r requirements.txt + ``` + +## Lancement de l'API + +Utiliser la commande suivante pour démarrer le serveur : + +```powershell +.\.venv\Scripts\python.exe -m uvicorn main:app --reload --port 8000 +``` + +> Important : si le lanceur `\.venv\Scripts\uvicorn.exe` est cassé après un déplacement de dossier, utilisez toujours `python -m uvicorn`. + +## Vérification + +- Swagger : `http://127.0.0.1:8000/docs` +- Santé : `http://127.0.0.1:8000/health` diff --git a/requirements.txt b/requirements.txt new file mode 100644 index 0000000..1e3bf06 --- /dev/null +++ b/requirements.txt @@ -0,0 +1,4 @@ +fastapi==0.136.0 +uvicorn==0.46.0 +pyodbc==5.3.0 +requests==2.33.1