Notebooks Jupyter: Testes de ponta a ponta e documentação em um só lugar

2024-12-18

Durante o desenvolvimento de uma biblioteca de computação quântica, o autor utilizou Notebooks Jupyter como guias do usuário e testes de ponta a ponta. Lendo variáveis de ambiente (como SERVER_URL) dentro dos notebooks, foi possível alcançar a parametrização, permitindo a execução por usuários e pipelines de CI/CD automatizados. Dois métodos para executar notebooks foram explorados: nbclient para simplicidade e nbconvert/jq para maior controle, porém com maior complexidade. O autor optou pela facilidade de uso do nbclient, integrando efetivamente a manutenção da documentação e os testes de código, garantindo a integridade de ambos a cada solicitação de mesclagem.

Desenvolvimento Testes de ponta a ponta