Déployer le plugin via un ZIP¶

Contexte¶

Le repertoire d'installation du plugin QGIS Isogeo

Sous Windows, le plugin QGIS Isogeo est installé dans :

C:\Users\%userprofile%\AppData\Roaming\QGIS\QGIS3\profiles\default\python\plugins\isogeo_search_engine

Sous Ubuntu, le plugin QGIS Isogeo est installé dans :

/home/%userprofile%/.local/share/QGIS/QGIS3/profiles/default/python/plugins/isogeo_search_engine

Une grande partie des paramétrages liés à l'utilisation du plugin Isogeo est enregistrée dans le répertoire d'installation du plugin. C'est notamment le cas :

du fichier client_secrets.json utilisé pour l'authentification (dans le sous-dossier _auth)
des recherches rapides et de la recherche par défaut qui sont écrites dans un fichier quicksearches.json (dans le sous-dossier _user)
des connexions aux bases de données configurées dans le fichier db_connections.json (dans le sous-dossier _user)

D'autre part, le gestionnaire des extensions de QGIS permet d'installer un plugin à partir d'une archive .zip. Il est donc possible, dans le cas d'une organisation où les utilisateurs finaux du plugin Isogeo sont nombreux, de leur éviter d'avoir à effectuer eux-mêmes certains paramétrages qui sont communs à tous les utilisateurs.

Prenons l'exemple suivant

Un utilisateur X est responsable de la diffusion du plugin QGIS Isogeo auprès d'une dizaine d'utilisateurs appartenant à son organisation :

le fichier d'authentification client_secrets.json est probablement commun à toute l'organisation
les données auxquelles les utilisateurs finaux pourront accéder via le plugin Isogeo sont stockées dans une même base de données à laquelle tous les utilisateurs ont accès
une partie de ces données est susceptible d'être utile à tous les utilisateurs

Dans ce cas, l'utilisateur X peut :

authentifier le plugin avec le client_secrets.json commun à toute son organisation
configurer dans le fichier db_connections.json la connexion à la base de données de l'organisme
sauvegarder des recherches rapides englobant les métadonnées relatives à des données utiles à tous les utilisateurs

Une fois ce paramétrage effectué par l'utilisateur X, il peut générer un .zip à partir du répertoire d'installation du plugin sur son poste et le diffuser auprès de la dizaine d'utilisateurs finaux qui n'auront pas à s'authentifier, à configurer la connexion à la base de données ou à sauvegarder certaines recherches rapides.

Marche à suivre¶

Installer le plugin et s'authentifier en indiquant l'emplacement du fichier client_secrets.json fourni par l'équipe Isogeo. Le fichier est copié dans le dossier _auth du répertoire d'installation du plugin sur le poste de l'utilisateur.
Sur le même poste, paramétrer le plugin :
1. en sauvegardant des recherches rapides
2. en établissant une recherche par défaut
3. en configurant des connections à des bases de données dans le fichier _user/db_connections.json
Toujours sur le même poste, créer une archive .zip à partir du répertoire d'installation du plugin :

Cette archive .zip contient les fichiers client_secrets.json, quicksearches.json et db_connections.json résultant des deux premières étapes.
Diffuser l'archive .zip ainsi créée auprès des autres utilisateurs qui pourront installer le plugin QGIS Isogeo directement à partir du fichier isogeo_search_engine.zip (Menu "Installer/Gérer les extensions" > onglet "Installer depuis un ZIP").

Pour les utilisateurs qui installeront le plugin ainsi, l'authentification sera automatique (sans passer par le formulaire d'authentification) car le fichier client_secrets.json sera déjà présent dans le dossier _auth du plugin Isogeo.