- O documento introduz o framework nbdev para desenvolvimento de pacotes e interfaces de linha de comando em Python utilizando Jupyter Notebooks, permitindo escrever, testar, documentar e distribuir software de forma integrada.

1. nbdev
Create delightful software
with Jupyter Notebooks
Março de 2023

2. SUMÁRIO
● Introdução
● Primeiros Passos
● Desenvolvendo o Core da Aplicação
● Atualizando o README.md
● Desenvolvendo a CLI
● Subindo o pacote pro PyPi
● 6 Meses Utilizando o nbdev
● Referências

3. INTRODUÇÃO

4. https://nbdev.fast.ai/
Write, test, document, and distribute software packages and technical
articles — all in one place, your notebook
O nbdev é um framework para desenvolvimento de pacotes e
interfaces de linha de comando em Python

5. https://en.wikipedia.org/wiki/Literate_programming
O nbdev implementa o conceito de literate programming,
desenvolvido por Donald Knuth em 1984 e que sugere que
código, testes e documentação sejam escritos em um único
documento

6. https://en.wikipedia.org/wiki/Jeremy_Howard_(entrepreneur)
O nbdev foi desenvolvido por Jeremy Howard, já foi Presidente
e Chief Scientist do Kaggle, co-fundador da fast.ai e do curso
gratuito de Practical Deep Learning for Coders

7. Empresas que utilizam o nbdev

8. https://nbdev.fast.ai/explanations/why_nbdev.html

9. PRIMEIROS PASSOS

10. Instalando e criando um projeto nbdev

11. Inspecionando um projeto nbdev

12. Servindo a documentação no localhost: nbdev_preview

13. Fazendo primeira modificação: nbdev_prepare

14. Subindo código pro github

15. Criando o repositório no github

16. Linkando o repositório no github com o repositório local

17. Linkando o repositório no github com o repositório local

18. Verificando o pipeline de CI no Github Actions

19. Habilitando o deploy no Github Pages

20. Habilitando o deploy no Github Pages

21. Habilitando o deploy no Github Pages

22. Checando o link da documentação criada

23. Disponibilizando o link da documentação na página inicial do repositório

24. Disponibilizando o link da documentação na página inicial do repositório

25. Fluxo de Desenvolvimento
● Escreve código nos jupyter notebooks
● Uma vez escrito os códigos, executar o comando nbdev_prepare
● Commit e Push para o repositório no github
● Aguardar finalização do pipeline de CI finalizar com sucesso
● Checar se a documentação foi atualizada
● Vamos exemplificar esse fluxo atualizando o arquivo nbs/00_core.ipynb
para incluir o core da nossa aplicação e criando uma cli

26. DESENVOLVENDO O CORE DA
APLICAÇÃO

27. Desenvolvendo o core da aplicação no arquivo nbs/00_core.ipynb

28. Desenvolvendo o core da aplicação no arquivo nbs/00_core.ipynb

29. Desenvolvendo o core da aplicação no arquivo nbs/00_core.ipynb

30. Desenvolvendo o core da aplicação no arquivo nbs/00_core.ipynb

31. Desenvolvendo o core da aplicação no arquivo nbs/00_core.ipynb

32. ATUALIZANDO O README.md

33. Atualizando o arquivo nbs/index.ipynb

34. Atualizando o arquivo nbs/index.ipynb

35. Atualizando o arquivo nbs/index.ipynb

36. DESENVOLVENDO A CLI

37. Desenvolvendo a CLI

38. Desenvolvendo a CLI - Linkando a cli com a função a ser executada

39. Desenvolvendo a CLI - testando

40. Desenvolvendo a CLI - testando

41. Desenvolvendo a CLI - documentação atualizada

42. SUBINDO O PACOTE PRO PYPI

43. Subindo o pacote pro PyPi

44. 6 MESES UTILIZANDO O NBDEV

45. 10 pacotes: todos com documentação no github pages

46. https://www.linkedin.com/posts/joaopaulonogueira_python-finanaexaspessoais-nbdev-activity-7012389493177528320-If2z/?utm_source=sha
re&utm_medium=member_desktop
Publicação com 800
curtidas no Linkedin

47. Vantagens e Benefícios do nbdev
Tempo entre desenvolvimento de uma solução (script, análise, consulta) até a distribuição em um
pacote python foi brutalmente reduzido
Contato prático com conceitos como CI/CD, documentação e testes desde o início do
desenvolvimento, sem muitas fricções ou necessidade de sair integrando diferentes soluções
que implementam isoladamente cada uma dessas necessidades.
Projetos mais fáceis de dar manutenção. Aquele medo de voltar a um projeto antigo e
implementar algo novo vai ser bastante mitigado.
Você será mais feliz e produtivo!

48. REFERÊNCIAS

49. Referências
Documentação do nbdev: https://nbdev.fast.ai/
A step-by-step guide to using nbdev: https://nbdev.fast.ai/tutorials/tutorial.html
Zero to published project in 90 minutes: https://www.youtube.com/watch?v=l7zS8Ld4_iA
nbdev v2 review: Git-friendly Jupyter Notebooks | InfoWorld