Jupyter Notebooks .gitignore テンプレート解説

JupyterNotebooks.gitignore はテンプレートリポジトリの community フォルダーにある短いテンプレートで、Jupyter と IPython がノートブックの横に作るファイルだけを扱う。仮想環境や __pycache__ は含まれていないため、Python テンプレートと併用する。

ノートブックファイル(.ipynb)の中に保存される実行結果や画像は gitignore の対象ではない。ファイル単位ではなくファイルの内容の問題なので、別のツールで扱う。

ルール別の解説

パターン	何を、なぜ無視するか
.ipynb_checkpoints*/.ipynb_checkpoints/*	チェックポイントJupyter が自動保存するときに、ノートブックがあるフォルダーごとに作るコピーである。1 行目はあらゆる深さのチェックポイントフォルダーを、2 行目は 1 階層下のフォルダー内の中身を明示的に捉える。
profile_default/ipython_config.py	IPython の設定IPython のプロファイルフォルダーと設定ファイルで、実行履歴のデータベースのように個人情報が入ることがある。
.virtual_documents/	JupyterLab LSPjupyterlab-lsp 拡張が言語サーバーにノートブックを渡すために作る仮想ドキュメントのフォルダーである。

実務での注意点

• ノートブックの出力をコミットしないようにするには、nbstripout を git フィルターとしてインストールするか、コミット前に出力を消すことを習慣にする。
• 大容量のデータファイル(data/、*.csv、*.parquet)はこのテンプレートでは防げない。必要なら直接追加するか、DVC・Git LFS を使う。
• .env に API キーを置いてノートブックから読み込むなら、Python テンプレートの .env ルールも必要である。

元のテンプレート

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

一緒に使うテンプレート