Gaphor sur Windows¶

Gaphor peut être installé avec notre programme d’installation. Consultez la page de téléchargement de Gaphor pour plus de détails.

Les versions antérieures sont disponibles sur GitHub.

CI builds sont également disponibles.

Environnement de développement¶

WinGet¶

Nous recommandons d’utiliser WinGet comme gestionnaire de paquets sous Windows. Il est disponible sur Windows 11 et les versions modernes de Windows 10 en tant qu’élément de l’App Installer.

Si vous avez une version un peu plus ancienne de Windows, vous pouvez également utiliser Chocolatey comme gestionnaire de paquets. Après l’avoir installé, exécutez choco install à la place des commandes winget install ci-dessous.

Git¶

Pour mettre en place un environnement de développement sous Windows, installez d’abord Git en vous exécutant en tant qu’administrateur :

winget install git.git

GTK et Python avec Gvsbuild¶

Gvsbuild fournit des bibliothèques GTK préconstruites pour Windows. Nous allons installer ces bibliothèques et Python.

Installer la dernière version de Python¶

Sous Windows, le programme d’installation complet contient tous les composants Python et constitue la meilleure option pour les développeurs qui utilisent Python pour tous leurs projets.

Pour plus d’informations sur l’utilisation de l’installateur officiel, veuillez consulter les instructions complètes de l’installateur. Les options d’installation par défaut devraient convenir à Gaphor.

Installez la dernière version de Python à l’aide de l”installateur officiel.
Ouvrez un terminal PowerShell en tant qu’utilisateur normal et vérifiez la version de python :
```
py -3.13 --version
```

Installer Graphviz¶

Graphviz est utilisé par Gaphor pour le formatage automatique des diagrammes.

Installer à partir de WinGet avec l’administrateur PowerShell :

winget install graphviz

Installer pipx¶

À partir du terminal PowerShell de l’utilisateur normal, exécutez :

py -3.13 -m pip install --user pipx
py -3.13 -m pipx ensurepath

Télécharger GTK¶

Téléchargez le fichier de la dernière version à l’adresse https://github.com/wingtk/gvsbuild/releases. Le fichier s’intitulera GTK4_Gvsbuild_VERSION_x64.zip, où VERSION correspond à la dernière version publiée.

Décompressez le fichier GTK4_Gvsbuild_VERSION_x64.zip dans C:\gtk. Par exemple avec 7Zip :

7z x GTK4_Gvsbuild_*.zip  -oC:\gtk -y

La structure de répertoire résultante devrait ressembler à ce qui suit :

C:\gtk
├── bin
├── include
├── lib
├── python
├── share
└── wheels

Mise en place Gaphor¶

Dans le même terminal PowerShell, clonez le dépôt :

cd (to the location you want to put Gaphor)
git clone https://github.com/gaphor/gaphor.git
cd gaphor

Installer Poetry :

pipx install poetry

Ajoutez GTK à vos variables d’environnement :

$env:Path = $env:Path + ";C:\gtk\bin;C:\Program Files\Graphviz\bin"
$env:LIB = "C:\gtk\lib"
$env:INCLUDE = "C:\gtk\include;C:\gtk\include\cairo;C:\gtk\include\glib-2.0;C:\gtk\include\gobject-introspection-1.0;C:\gtk\lib\glib-2.0\include;"
$env:GI_TYPELIB_PATH = "C:\gtk\lib\girepository-1.0"
$env:XDG_DATA_HOME = "$env:userprofile\.local\share"

Vous pouvez également modifier les «Variables d’Environnement» de votre compte pour qu’elles persistent entre les sessions PowerShell.

Installer les dépendances de Gaphor :

poetry install

Réinstaller PyGObject et pycairo en utilisant gvsbuild wheels :

poetry run pip install --force-reinstall (Resolve-Path C:\gtk\wheels\PyGObject*.whl)
poetry run pip install --force-reinstall (Resolve-Path C:\gtk\wheels\pycairo*.whl)

Lancer Gaphor !

poetry run gaphor

Mise en place d’un espace de travail de plugin pour Gaphor¶

Lors de la mise en place d’un espace de travail pour un plugin, vous devez effectuer les étapes suivantes :

cd (your project's workspace)

Si votre projet ne dispose pas encore d’un fichier pyproject.toml, créez-en un. Pour plus de détails, consultez la documentation de Poetry. Si vous disposez déjà d’un fichier .toml, assurez-vous que gaphor figure parmi vos dépendances de développement. Pour plus de détails, consultez le plugin Gaphor Hello World.

poetry init

Installez les dépendances de votre projet. Si vous avez rendu votre projet dépendant de Gaphor, cela va tirer Gaphor.

poetry install

Réinstaller PyGObject et pycairo en utilisant gvsbuild wheels :

poetry run pip install --force-reinstall (Resolve-Path C:\gtk\wheels\PyGObject*.whl)
poetry run pip install --force-reinstall (Resolve-Path C:\gtk\wheels\pycairo*.whl)

Notez que si vous avez oublié de réinstaller PyGObject et pycairo, gaphor plantera la première fois que vous ajoutez un élément à un diagramme qui contient du texte !

Lancer Gaphor !

poetry run gaphor

Débogage à l’aide de Visual Studio Code¶

Démarrez un nouveau terminal PowerShell et définissez le répertoire courant comme étant le dossier du projet :

cd (to the location you put gaphor)

Assurez-vous que la variable d’environnement path est définie :

$env:Path = "C:\gtk\bin;" + $env:Path

Démarrez Visual Studio Code :

code .

Pour lancer le débogueur, procédez comme suit :

Ouvrir le fichier __main__.py du dossier gaphor
Ajouter un point d’arrêt sur la ligne main(sys.argv)
Dans le menu, sélectionnez Exécuter → Démarrer le débogage
Sélectionnez Sélectionner un module dans la liste
Entrez gaphor comme nom de module

Visual Studio Code démarrera l’application en mode débogage et s’arrêtera à l’étape principale.

Débogage de votre plugin à l’aide de Visual Studio Code¶

cd (your project's workspace)

Démarrer gaphor :

Dans le menu VSCode, sélectionnez Exécuter → Démarrer le débogage
Sélectionnez Sélectionner un module dans la liste
Entrez gaphor comme nom de module

Votre plugin devrait apparaître dans le menu Outils.

Empaquetage pour Windows¶

Pour créer un fichier d’installation exe pour Windows, nous utilisons PyInstaller, qui analyse Gaphor afin d’identifier toutes les dépendances et de les regrouper dans un seul dossier. Nous utilisons ensuite un script bash personnalisé qui crée un programme d’installation Windows à l’aide de NSIS et un programme d’installation portable à l’aide de 7-Zip. Pour les installer, ouvrez PowerShell en tant qu’administrateur, puis exécutez :

winget install nsis 7zip

Puis construisez votre programme d’installation en utilisant :

poetry install --only main,packaging,automation
poetry run pip install --force-reinstall (Resolve-Path C:\gtk\wheels\PyGObject*.whl)
poetry run pip install --force-reinstall (Resolve-Path C:\gtk\wheels\pycairo*.whl)
poetry build
poetry run poe package
poetry run poe win-installer

Installation limitée d’Anaconda¶

Il peut parfois être utile d’appeler les fonctionnalités de Gaphor depuis une console Python sur des ordinateurs qui n’ont pas la possibilité d’effectuer une installation de développement complète (par exemple, sans privilèges d’administration). Parce que toutes les dépendances nécessaires à la construction de Gaphor (en particulier, gtksourceview5etlibadwaita) ne sont pas disponibles en tant que paquets Anaconda, vous ne pourrez pas construire le programme ni instancier ou exécuter des classes d'application comme ApplicationandSession`.

Cependant, cette configuration peut être utile si vous souhaitez utiliser Gaphor en tant que bibliothèque dans le cadre d’un projet plus important. Dans ce cas, Gaphor peut être installé comme un paquet dans un environnement Anaconda en suivant le processus suivant :

Créer un nouvel environnement Anaconda¶

Si vous utilisez Anaconda pour d’autres projets, il est conseillé de créer un nouvel environnement pour Gaphor, afin d’éviter tout conflit avec votre environnement de développement préexistant. Pour ce faire, lancez la commande suivante depuis l’invite de Anaconda :

conda create -n "gaphor"
conda activate gaphor

où gaphor peut être n’importe quel nom souhaité pour l’environnement.

Mettre à jour les paquets dans le nouvel environnement¶

Obtenez les paquets les plus récents en utilisant :

conda update --all

Installer les dépendances¶

Les dépendances Gaphor suivantes peuvent être installées à partir d’Anaconda :

conda install graphviz
conda install -c conda-forge gobject-introspection gtk4 pygobject pycairo hicolor-icon-theme adwaita-icon-theme

Malheureusement, les dépendances gtksourceview5 et libadwaita ne sont pas disponibles en tant que paquets Anaconda. Il se peut donc que vous ne puissiez pas compiler ni exécuter complètement le programme dans cet environnement.

Mise en place de l’environnement de développement¶

Maintenant, pour développer avec Gaphor, vous allez devoir le configurer avec votre développement. Si vous voulez travailler avec ipython, installez-le ci-dessous :

conda install ipython ipykernel

Astuces VSCode¶

VSCode devrait fonctionner sans problème s’il est déjà installé. Il suffit de définir “gaphor” comme noyau dans votre profil ou bloc-notes VSCode.

Astuces Spyder¶

Vous pouvez installer Spyder dans cet environnement en utilisant conda install spyder.

Si cela ne fonctionne pas (c’est-à-dire si conda install spyder révèle des conflits), vous pouvez utiliser la solution suivante :

conda install spyder-kernels=2.4

Ensuite, dans Spyder, définissez “gaphor” comme votre interpréteur python

Installer Gaphor¶

Depuis une console python fonctionnant dans votre nouvel environnement anaconda, vous pouvez alors installer Gaphor à l’aide de pip :

pip install gaphor