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

Démarrer le développement dans le cadre du projet DataLab est facile.

Voici ce dont vous aurez besoin :

Un environnement de développement intégré (IDE) pour Python. Nous recommandons Spyder ou Visual Studio Code, mais tout IDE fera l’affaire.
Une distribution Python. Nous recommandons WinPython, sur Windows, ou Anaconda, sur Linux ou Mac. Mais, encore une fois, n’importe quelle distribution Python fera l’affaire.
Une structure de projet propre (voir ci-dessous).
Des données de test (voir ci-dessous).
Des variables d’environnement (voir ci-dessous).
Des logiciels tiers (voir ci-dessous).

Environnement de développement#

Si vous utilisez Spyder, merci de soutenir la communauté scientifique Python open-source !

Si vous utilisez Visual Studio Code, c’est aussi un excellent choix (pour d’autres raisons). Nous recommandons d’installer les extensions suivantes :

Extension	Description
gettext	Coloration syntaxique Gettext
Pylance	Serveur de langage Python
Python	Extension Python
reStructuredText Syntax highlighting	Coloration syntaxique reStructuredText
Ruff	Linter et formateur de code Python extrêmement rapide
Todo Tree	Arbre de tâches
Insert GUID	Insérer un GUID
XML Tools	Outils XML

Environnement Python#

Sigima nécessite les éléments suivants :

Python (p.ex. WinPython)
Paquets Python supplémentaires

Installation de tous les paquets requis :

pip install --upgrade -r requirements.txt

Si vous utilisez WinPython, merci de soutenir la communauté scientifique Python open-source !

Le tableau suivant liste les distributions Python actuellement utilisées officiellement :

Version de Python	Statut	Version de WinPython
3.9	OK	3.9.10.0
3.10	OK	3.10.11.1
3.11	OK	3.11.5.0
3.12	OK	3.12.3.0
3.13	OK	3.13.2.0

⚠ Nous recommandons fortement d’utiliser les versions .dot de WinPython qui sont légères et peuvent être personnalisées selon vos besoins (en utilisant pip install -r requirements.txt).

✅ Nous recommandons également d’utiliser une instance WinPython dédiée pour Sigima.

Données de test#

Les données de test de Sigima sont situées dans différents dossiers, selon leur nature ou leur origine.

Les données requises pour les tests unitaires sont situées dans « sigima\data\tests » (données publiques)

Un second dossier %SIGIMA_DATA% (facultatif) peut être défini pour des tests supplémentaires qui sont encore en cours de développement (ou pour des données confidentielles).

Variables d’environnement spécifiques#

La configuration de Visual Studio Code utilisée dans launch.json et/ou tasks.json (exemples) :

@REM Folder containing additional working test data
set SIGIMA_DATA=C:\Dev\Projets\SIGIMA_data

Fichier .env de Visual Studio Code :

Ce fichier est utilisé pour définir les variables d’environnement de l’application.
Il est utilisé pour définir la variable d’environnement PYTHONPATH à la racine du projet.
Cela est nécessaire pour pouvoir importer les modules du projet depuis VS Code.
Pour créer ce fichier, copiez le fichier .env.template en .env (et ajoutez éventuellement vos propres chemins).

Logiciels tiers#

Les logiciels suivants peuvent être nécessaires pour maintenir le projet :

Logiciel	Description
gettext	Traductions
Git	Système de contrôle de version
ImageMagick	Utilitaires de manipulation d’images