Alti-api
API REST pour le calcul altimétrique.
Environnement
Créer un environnement virtuel python
python3 -m pip install virtualenv
python3 -m virtualenv .venv
Se créer un fichier de variables d'environnement .env
à partir du fichier .example.env
et modifier les différentes variables.
cp .example.env .env
En fonction de votre système d'exploitation, les commandes à exécuter pour installer les librairies nécessaires au bon fonctionnement sont différentes.
Linux
source .venv/bin/activate
python3 -m pip install -e .[dev]
Windows
Sous Windows, il y a de fortes chances que vous rencontriez des difficultés lors de l'installation de la librairie gdal
.
Pour simplifier et assurer la bonne installation, nous allons installer cette librairie via une wheel que vous pouvez télécharger sur un des sites suivants :
-
https://github.com/cgohlke/geospatial.whl/releases (des versions plus récentes de gdal à partir de la
3.6.1
). -
https://www.lfd.uci.edu/~gohlke/pythonlibs/ (site plus maintenu mais des versions gdal inférieures à la version
3.6.1
)
Sur le premier site, vous pouvez par exemple télécharger le fichier GDAL-3.6.2-cp310-cp310-win_amd64.whl
Grâce à cette wheel, vous installerez la version 3.6.2
de gdal.
Cette wheel nécessite Python 3.10
au minimum (version minimale spécifiée dans le nom du fichier, ex cp310
).
Cette wheel nécessite un Windows 64 bits
(spécifiée dans le nom du fichier, ex win_amd64
).
source .\venv\Scripts\activate
python3 -m pip install "PATH_TO_THE_WHEEL\GDAL-3.3.3-cp310-cp310-win_amd64.whl"
python3 -m pip install -e .[dev]
API
# lancer l'API
python3 -m uvicorn alti_api.main:alti_api --reload
Une fois lancée, un swagger est visualisable http://localhost:8000/docs
Tests unitaires
pytest