Jupyter-Notebooks-.gitignore-Vorlage erklärt

JupyterNotebooks.gitignore ist eine kurze Vorlage im community-Ordner des Vorlagen-Repositorys und behandelt nur Dateien, die Jupyter und IPython neben Notebooks anlegen. Virtuelle Umgebungen und __pycache__ sind nicht enthalten; verwenden Sie sie deshalb zusammen mit der Python-Vorlage.

Ausführungsergebnisse und Bilder, die in der Notebook-Datei (.ipynb) gespeichert werden, sind kein Fall für gitignore. Es geht um den Inhalt einer Datei, nicht um ganze Dateien – dafür braucht es ein separates Werkzeug.

Regeln im Einzelnen

Muster	Was ignoriert wird und warum
.ipynb_checkpoints*/.ipynb_checkpoints/*	CheckpointsKopien, die Jupyter beim automatischen Speichern in jedem Ordner mit einem Notebook anlegt. Die erste Zeile erfasst Checkpoint-Ordner in jeder Tiefe, die zweite ausdrücklich den Inhalt solcher Ordner eine Ebene tiefer.
profile_default/ipython_config.py	IPython-KonfigurationIPython-Profilordner und Konfigurationsdateien; sie können persönliche Daten enthalten, etwa die Datenbank des Ausführungsverlaufs.
.virtual_documents/	JupyterLab LSPOrdner mit virtuellen Dokumenten, den die Erweiterung jupyterlab-lsp anlegt, um Notebooks an den Sprachserver zu übergeben.

Hinweise für die Praxis

• Um keine Notebook-Ausgaben zu committen, installieren Sie nbstripout als git-Filter oder gewöhnen sich an, Ausgaben vor dem Commit zu löschen.
• Große Datendateien (data/, *.csv, *.parquet) blockiert diese Vorlage nicht. Ergänzen Sie sie bei Bedarf selbst oder verwenden Sie DVC oder Git LFS.
• Wenn Sie API-Schlüssel in .env ablegen und im Notebook einlesen, brauchen Sie zusätzlich die Regel .env der Python-Vorlage.

Originalvorlage

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

Häufig kombinierte Vorlagen