Installation¶
Il est possible d’installer le projet de deux façon différentes, en plus de celle du mode développement.
Pip¶
Prérequis¶
Python >= 3.10
Accès réseau sur:
l’instance GitLab : https://gitlab.gpf-tech.ign.fr
le dépôt officiel de paquets Python : https://pypi.org/
un jeton d’accès personnel ou Personal Access Token (PAT) avec le scope
read_api
Installer¶
Dans les commandes suivantes, remplacer :
<personal_access_token_name>avec le nom de votre jeton (PAT). Exemple :oche<personal_access_token_value>avec la valeur de votre jeton (PAT). Exemple :aBcdEfghIJKLMNoP9R7s
# Windows: py -3
python3 -m pip install -U gpf-entrepot-toolbelt --index-url https://<personal_access_token_name>:<your_personal_token>@gitlab.gpf-tech.ign.fr/api/v4/groups/55/-/packages/pypi/simple
Derrière un proxy¶
Pour les proxy de type socks, installer :
python3 -m pip install -U "PySocks<2"
Puis ajouter l’URL du proxy en option :
# Windows: py -3
python3 -m pip install -U gpf-entrepot-toolbelt --index-url https://<personal_access_token_name>:<your_personal_token>@gitlab.gpf-tech.ign.fr/api/v4/groups/55/-/packages/pypi/simple --proxy socks5://localhost:8645
Note
Nous utilisons ici l’identifiant du groupe geoplateforme (55). Cet identifiant est visible sous le nom, sur la page du groupe.
Il est aussi possible d’utiliser le registre lié au projet où des instructions détaillées sont fournies au clic sur le package :
Options d’installation¶
De façon à conserver le projet le plus léger possible, certaines dépendances sont optionnelles et définies dans la variable extra_requires du fichier setup.py : (https://gitlab.gpf-tech.ign.fr/geoplateforme/gpf-entrepot-toolbelt-py/-/tree/main/setup.py).
Installer les dépendances liées au client PostgreSQL¶
En pur Python¶
Si la bibliothèque du client PostgreSQL est installée, la toolbelt intègre ce qu’il faut.
Typiquement, sur les distributions basées sur Debian sur :
sudo apt install libpq5
Avec les binaires précompilés¶
python3 -m pip install -U gpf-entrepot-toolbelt[pg_bin]
Avec les headers C¶
python3 -m pip install -U gpf-entrepot-toolbelt[pg_c]
Docker¶
Note
L’image est configurée à des fins d’utilisation et non à des fins de développement.
A ce titre l’image ne contient que le code source et le nécessaire pour installer le programme. Donc, il n’y a pas les dossiers docs, tests, etc.
Si besoin, ajuster le fichier .dockerignore.
Prérequis¶
Docker >= 20.10
Builder l’image¶
docker build --pull --rm -f "Dockerfile" -t gpf-entrepot-toolbelt "."
Exécuter l’image dans un conteneur¶
Entrer dans le conteneur et exécuter des commandes de façon interactive :
> docker run --rm -it gpf-entrepot-toolbelt:latest
root@55c5de0191ee:/user/app# pip show gpf_entrepot_toolbelt
Exécuter le programme dans le conteneur :
> docker run --rm gpf-entrepot-toolbelt:latest pip show gpf_entrepot_toolbelt