Jupyter Notebooks: End-to-End-Tests und Dokumentation in einem

Bei der Entwicklung einer Quantencomputer-Bibliothek nutzte der Autor Jupyter Notebooks sowohl als Benutzerhandbücher als auch für End-to-End-Tests. Durch das Auslesen von Umgebungsvariablen (z. B. SERVER_URL) in den Notebooks wurde eine Parametrisierung erreicht, die sowohl die Ausführung durch Benutzer als auch durch automatisierte CI/CD-Pipelines ermöglicht. Zwei Methoden zum Ausführen von Notebooks wurden untersucht: nbclient für die Einfachheit und nbconvert/jq für mehr Kontrolle, aber erhöhte Komplexität. Der Autor entschied sich für die Benutzerfreundlichkeit von nbclient und integrierte so effektiv die Dokumentationswartung und Code-Tests, wodurch die Integrität beider bei jeder Merge-Request gewährleistet ist.