Cette documentation décrit comment installer et démarrer le projet OSM Trip API.
pip)Création de l'environnement virtuel :
python -m venv .venv
Activation de l'environnement virtuel :
source .venv/bin/activate
.venv\Scripts\activate.bat
Mise à jour de pip et installation des dépendances :
pip install -U pip
pip install .
# Ou, pour le mode développement avec les dépendances (pytest, ruff, etc.) :
# pip install -e .[dev]
Le projet utilise des fichiers .env (ex: .env.dev, .env.prod) pour charger ses variables de configuration. Créez un fichier .env.dev à la racine pour la configuration locale.
Exemple de variables génériques nécessaires :
export USER_AGENT='MyApp/1.0 (contact: votree@email.com)'
export CONTACT_EMAIL='votree@email.com'
Note : Aucun mot de passe, token ou hôte de production ne doit être versionné.
uvicorn app.main:app --env-file ".env.dev" --reload --host 127.0.0.1 --port 8000
Des scripts de confort sont disponibles selon votre système d'exploitation :
start.bat dev (ou start.bat prod)./start.sh devUne fois l'API démarrée, la documentation interactive Swagger est consultable sur http://127.0.0.1:8000/docs.