nbwipers-pre-commit

This mirror repository allows using nbwipers in pre-commit without the need to compile with rust.

You can add the following to your pre-commit-config.yaml file to ensure that nbwipers or nbstripout is installed in your repo, in order to prevent Jupyter notebook outputs from being committed to version control.

  - repo: https://github.com/felixgwilliams/nbwipers-pre-commit
    rev: v0.6.1
    hooks:
      - id: nbwipers-check-install

If you use the check-large-files hook from pre-commit, you may get "false positives", since it checks the sizes not-clean notebook files in the working directory. You can use the version included in this repository, which cleans notebooks before checking their size.

  - repo: https://github.com/felixgwilliams/nbwipers-pre-commit
    rev: v0.6.1
    hooks:
      - id: nbwipers-large-files

nbwipers can also record the information about notebook kernels via nbwipers record. If you use the strip-kernel-info option with the git filter, the kernel info will be stripped from all notebooks before they are committed. However, if you had recorded the kernel info, it will be restored by the nbwipers git smudge filter. This allows you to change branches and discard changes in your .ipynb files without losing information about which kernels were used for each notebook.

  - repo: https://github.com/felixgwilliams/nbwipers-pre-commit
    rev: v0.6.1
    hooks:
      - id: nbwipers-record

If you want to check that your notebooks are clean in your working directory, you can use the nbwipers-check-wd hook. This is probably overkill.

  - repo: https://github.com/felixgwilliams/nbwipers-pre-commit
    rev: v0.6.1
    hooks:
      - id: nbwipers-check-wd