Modifier le programme

Cette page s'adresse à qui veut modifier GdArt.

Organisation du code

Le programme est dans src/, en Python, sans autre dépendance que PyYAML. Le code est écrit pour être lu : noms explicites, fonctions courtes, commentaires en français.

Fichier

Rôle

GdArt.py

le menu

commun.py

affichage, saisie au clavier, fichiers, réseau

configuration.py

config.yaml, input.yaml, cles.yaml et l'assistant (menu 0)

sources.py

les requêtes et les bases bibliographiques

zotero.py

la bibliothèque Zotero

projets.py

la liste des projets (dossier GdArt), création, import

projet.py

le projet en cours, et le format de ses fichiers (décrit en tête du fichier)

migration.py

conversion des fichiers d'une ancienne version

apercu.py, etape1_recherche.py ... etape6_references.py

une étape du menu par fichier

journal.py

le journal (menu j)

Le banc d'essai

Avant et après une modification, lancez le banc d'essai :

python3 tests/comparer.py          # compare src/ avec le dernier commit
python3 tests/comparer.py main     # compare src/ avec la branche main

Il fait tourner les deux versions sur des données d'exemple inventées (tests/donnees/), avec de fausses bases et un faux Zotero (aucun accès à internet), et compare tout ce qu'elles produisent : fichiers, requêtes envoyées, chiffres du menu. Les scénarios sont décrits en tête de tests/scenarios.py.

  • « TOUT IDENTIQUE » : le comportement n'a pas changé ;

  • « DIFFÉRENT » : il montre les premières différences, à vérifier une par une ;

  • les scénarios des nouveautés vérifient leurs propres contrôles (« CONTRÔLES RÉUSSIS »).

Cette documentation

Elle est dans doc/, au format Sphinx (voir doc/README.md pour la construire et la prévisualiser).