Template .gitignore do Jupyter Notebooks explicado
Explica por que o JupyterNotebooks.gitignore ignora .ipynb_checkpoints, o perfil do IPython e .virtual_documents, e como gerenciar as saídas dos notebooks.
O JupyterNotebooks.gitignore é um template curto da pasta community do repositório de templates e trata apenas dos arquivos que o Jupyter e o IPython criam ao lado dos notebooks. Não inclui ambientes virtuais nem __pycache__, então é usado junto com o template do Python.
Os resultados de execução e as imagens salvos dentro do arquivo de notebook (.ipynb) não são alvo do gitignore. Não é uma questão de arquivos, e sim do conteúdo do arquivo, então é tratado com outras ferramentas.
Explicação regra por regra
| Padrão | O que ignora e por quê |
|---|---|
.ipynb_checkpoints*/.ipynb_checkpoints/* | CheckpointsSão cópias que o Jupyter cria em cada pasta com notebooks ao salvar automaticamente. A primeira linha pega as pastas de checkpoints em qualquer profundidade, e a segunda indica explicitamente o conteúdo das pastas um nível abaixo. |
profile_default/ipython_config.py | Configuração do IPythonSão a pasta de perfil e o arquivo de configuração do IPython, que podem conter informações pessoais como o banco de dados do histórico de execução. |
.virtual_documents/ | LSP do JupyterLabÉ a pasta de documentos virtuais que a extensão jupyterlab-lsp cria para passar os notebooks ao servidor de linguagem. |
Cuidados na prática
- Para não commitar as saídas dos notebooks, instale o
nbstripoutcomo filtro do git ou crie o hábito de limpar as saídas antes do commit. - Este template não bloqueia arquivos de dados grandes (
data/,*.csv,*.parquet). Se necessário, adicione-os você mesmo ou use DVC ou Git LFS. - Se você guarda chaves de API no
.enve as lê no notebook, também precisa da regra.envdo template do Python.
Template original
# gitignore template for Jupyter Notebooks# website: http://jupyter.org/.ipynb_checkpoints*/.ipynb_checkpoints/*# IPythonprofile_default/ipython_config.py# Jupyter lab virtual documents# https://jupyterlab-lsp.readthedocs.io/en/2.x/Configuring.html#virtual_documents_dir.virtual_documents/# Remove previous ipynb_checkpoints# git rm -r .ipynb_checkpoints/
Origem dos templates: github/gitignore/community/Python/JupyterNotebooks.gitignore @356fd7b (2026-09-11) · CC0-1.0