install

pip install git+https://github.com/lewagon/nbcleanmeta

uninstall

pip uninstall -y nbcleanmeta

aliases

alias nbc="nbcleanmeta $@"

about

clean notebook cell data and metadata in order to maintain clear git diffs

usage

clean

clean data and metadata of the cells of the notebooks within the provided scope

nbcleanmeta run                         # clean all notebooks in current directory tree
nbcleanmeta run sources                 # clean individual notebooks and directory trees
nbcleanmeta run --help                  # list options

processed cell data:

• execution_count (set to 0)

deleted cell data:

• id

deleted cell metadata:

• id
• outputId
• scrolled
• ExecuteTime
• execution
• hidden
• collapsed
• heading_collapsed
• vscode
• colab
• editable
• tags if empty
• slideshow.slide_type if empty
• slideshow if empty

stats

return stats on cell data, metadata and tags used in the notebooks within the provided scope

return stats on delimiters used in the files and notebooks within the provided scope

nbcleanmeta stats                       # retrieve stats on current directory tree
nbcleanmeta stats sources               # retrieve stats on individual files and directory trees
nbcleanmeta stats --help                # list options

convert

this is deprecated and has been replaced by challengify

converts a solutions notebook into a challenges notebook by removing all the cells with slide type set to notes (additionally to cleaning the notebook)

nbcleanmeta run --delete-notes notebook.ipynb  # do not use