Разбор шаблона .gitignore для Jupyter Notebooks

JupyterNotebooks.gitignore — короткий шаблон из папки community репозитория шаблонов; он охватывает только файлы, которые Jupyter и IPython создают рядом с блокнотами. Виртуальных окружений и __pycache__ в нём нет, поэтому используйте его вместе с шаблоном Python.

Результаты выполнения и изображения, сохранённые внутри файла блокнота (.ipynb), не являются предметом gitignore. Это вопрос не файлов, а содержимого файла, поэтому с ним работают отдельными инструментами.

Разбор правил

Шаблон	Что и почему игнорируется
.ipynb_checkpoints*/.ipynb_checkpoints/*	Контрольные точкиКопии, которые Jupyter при автосохранении создаёт в каждой папке с блокнотами. Первая строка охватывает папки контрольных точек на любой глубине, вторая явно охватывает содержимое папки на один уровень ниже.
profile_default/ipython_config.py	Настройки IPythonПапки профилей и файлы настроек IPython; в них могут попасть личные данные, например база истории выполнения.
.virtual_documents/	JupyterLab LSPПапка виртуальных документов, которую создаёт расширение jupyterlab-lsp, чтобы передавать блокноты языковому серверу.

На что обратить внимание на практике

• Чтобы не коммитить вывод блокнотов, установите nbstripout как фильтр git или возьмите за привычку очищать вывод перед коммитом.
• Большие файлы данных (data/, *.csv, *.parquet) этот шаблон не блокирует. При необходимости добавьте правила сами или используйте DVC или Git LFS.
• Если API-ключи лежат в .env и читаются из блокнота, понадобится и правило .env из шаблона Python.

Исходный шаблон

# 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/

Шаблоны, используемые вместе