Notebooks Jupyter: Pruebas de extremo a extremo y documentación en uno

2024-12-18

Durante el desarrollo de una biblioteca de computación cuántica, el autor aprovechó los Notebooks Jupyter como guías de usuario y pruebas de extremo a extremo. Al leer variables de entorno (como SERVER_URL) dentro de los notebooks, logró la parametrización, permitiendo la ejecución por usuarios y pipelines de CI/CD automatizados. Se exploraron dos métodos para ejecutar notebooks: nbclient por simplicidad, y nbconvert/jq para mayor control pero mayor complejidad. El autor optó por la facilidad de uso de nbclient, integrando eficazmente el mantenimiento de la documentación y las pruebas de código, asegurando la integridad de ambos con cada solicitud de fusión.