custom blacklist metadata fields

[casperdcl]

Complements #86

• [x] support metadata
• [x] support cell.metadata
• [x] fix #85
  • [x] custom top level metadata (e.g. metadata.toc)
  • [x] custom top levels cell.metadata (e.g. cell.metadata.heading_collapsed
• [x] fix #72
  • [x] top-level
  • metadata.kernel_spec
  • metadata.language_info
  • [x] nested only
  • metadata.kernel_spec.display_name
  • metadata.kernel_spec.name
  • metadata.language_info.codemirror_mode.version
  • metadata.language_info.pygments_lexer
  • metadata.language_info.version
• [ ] possibly support non-metadata fields?
• [x] add tests
  • [x] modularise/package to fix tests
• [x] add documentation
• [ ] bump version

This is configurable via git config (--global) filter.nbstripout.extrakeys. An example would be:

git config --global filter.nbstripout.extrakeys \
  'metadata.toc cell.metadata.heading_collapsed cell.metadata.hidden cell.metadata.code_folding'

[kynan]

Python 3 tests are failing now, however I can't quite see how that's related to your changes.

[dnhuizen]

This is a much needed feature, thanks for jumping on this: With Papermill gaining in popularity it is great to be able to strip out Papermill related metadata

[casperdcl]

OK @kynan @dnhuizen I think this is ready for merge. Should really bump the version number when that's done.

[kynan]

Thanks for your contribution!

[amard33p]

Is it possible to filter the key nbformat_minor with this feature?

[kynan]

@amard33p yes, should be. Is this a per-cell key? A "global" key?

[amard33p]

@amard33p yes, should be. Is this a per-cell key? A "global" key?

Not sure about that...but you can see it in the diff here: https://github.com/kynan/nbstripout/issues/110#issuecomment-580836467

[kynan]

Turns out nbformat_minor is actually a "top level" key and required, so stripping it would likely break the notebook.