development

Développement

Environnement de développement dans QGIS3 pour Windows

1. Installer QGIS3 LTR avec OSGeo4W en suivant cette documentation. Ou lancer les commandes suivantes dans Powershell (voir la doc officielle) après avoir télécharger l'installeur OSGeo4W :

# pour télécharger les paquets
.\osgeo4w-setup-x86_64.exe --quiet-mode --download --no-desktop --advanced --arch x86_64 --autoaccept --packages qgis-ltr-full
# lancer l'installation (sert aussi pour la mise à jour)
.\osgeo4w-setup-x86_64.exe --quiet-mode --delete-orphans --upgrade-also --no-desktop --advanced --arch x86_64 --autoaccept --packages qgis-ltr-full

2. Cloner le dépôt GitHub du plugin en exécutant cette commande dans un terminal cmd.

   git clone https://github.com/isogeo/isogeo-plugin-qgis.git <futur/emplacement/du/depot> --branch <branche_a_cloner>

3. Ouvrir le dossier futur/emplacement/du/depot dans Visual Studio Code

4. Modifier le fichier futur/emplacement/du/depot/.vscode/settings.json

   Il contient les paramétrages permettant d'établir l'environnement de développement à l'ouverture du projet dans VS Code. Pour adapter ces paramétrages à votre ordinateur, il convient de modifier/vérifier certaines valeurs.

   • Le paramètre "terminal.integrated.env.windows" permet de reproduire l'environnement de QGIS LTR, C'est une liste de couples "variable d'environnement":"valeur" dont il faut remplacer les valeurs par celles que l'on peut obtenir ainsi :

     1. Exécuter le fichier python-qgis-ltr.bat depuis l'invite de commande cmd (il se trouve sûrement dans OSGeo4W64/bin/) :

        >cd OSGeo4W64\bin
        
        >python-qgis-ltr.bat
        

        Cela permet d'exécuter la version de Python 3 installée avec OSGeo4W après avoir établi l'environnement de QGIS3 LTR.

     2. Arrêter l'exécution de Python 3 et afficher l'environnement de QGIS3 LTR à l'aide de ces commandes :

        >>> ^Z
        
        >set

        Les valeurs à inscrire dans le paramètre "terminal.integrated.env.windows" se trouvent dans la liste de variables d'environnement ainsi obtenue. Il est possible qu'elles ne diffèrent pas des valeurs initiales.

   • Les trois paramètres suivants servent au fonctionnement de l'extension PYQT Integration qui facilite la compilation des fichiers .ui d'interface graphique par Qt5:

     • Paramètre "pyqt-integration.qtdesigner.path" : chemin absolu du fichier qgis-ltr-designer.bat se trouvant dans le dossier d'installation d'OSGeo4W (surement dans OSGeo4W64/bin/).

     • Paramètre "pyqt-integration.pyuic.cmd" : chemin absolu du fichier pyuic5.bat se trouvant dans le dossier d'installation d'OSGeo4W (surement dans OSGeo4W64/apps/Python37/Scripts/).

     • Paramètre "pyqt-integration.pyrcc.cmd" : chemin absolu du fichier pyrcc5.bat se trouvant dans le dossier d'installation d'OSGeo4W (surement dans OSGeo4W64/apps/Python37/Scripts/).

   • Le paramètre "python.pythonPath" : chemin absolu du fichier python-qgis-ltr.bat se trouvant dans le dossier d'installation d'OSGeo4W (surement dans OSGeo4W64/bin/). Établit l'interpréteur Python utilisé par Visual Studio Code pour ce projet. Permet d'avoir accès à l'autocomplétion sur les modules (qgis.core, qgis.utils, qgis.PyQt) installés avec OSGeo4W.

5. Créer l'environnement virtuel en exécutant la commande suivante dans le terminal powershell de VSCode :

   > python -m venv .venv_tests --system-site-packages

6. Activer l'environnement virtuel au besoin en exécutant la commande suivante dans le terminal powershell de VSCode :

   > .\.venv_tests\Scripts\activate

Prérequis

Avoir installé Visual Studio Code ainsi que ses extensions Python et PYQT Integration.