Notebooks Jupyter : Tests de bout en bout et documentation en un
2024-12-18
Lors du développement d'une bibliothèque de calcul quantique, l'auteur a utilisé des Notebooks Jupyter à la fois comme guides d'utilisation et comme tests de bout en bout. En lisant des variables d'environnement (comme SERVER_URL) dans les notebooks, il a obtenu la paramétrisation, permettant l'exécution par les utilisateurs et les pipelines CI/CD automatisés. Deux méthodes d'exécution des notebooks ont été explorées : nbclient pour sa simplicité, et nbconvert/jq pour un contrôle plus fin mais une complexité accrue. L'auteur a opté pour la simplicité de nbclient, intégrant efficacement la maintenance de la documentation et les tests de code, assurant l'intégrité des deux à chaque demande de fusion.
Développement
Tests de bout en bout