FEAT: hook to run notebooks

Request

A pre-commit hook that ensures notebooks have valid code and will run without error.

Motivation

We may push notebooks to remote repos and later discover that users experience errors caused from typos or insufficient kernels/python versions. Using a pre-push hook to defensively “validate” notebooks can guard against simple errors and reduce calls to CI.

Approaches

There may be some approaches to this:

1. use nbconvert to run all notebooks
2. parse the ast based on the notebook’s kernel (potentially faster)

Examples

Pre-commit hook

repos:
-     repo:  https://github.com/nbQA-dev/nbQA/issues/new
      rev: <latest>
      hooks:
      - id: nbqa-valid-nb

[pylang]

I’m stunned. Fastest, most helpful response on GitHub I’ve experienced yet. Wow. Thank you all.

[MarcoGorelli]

@pylang this’ll be in the next release, but in the meantime, you can use it as

repos:
- repo: https://github.com/nbQA-dev/nbQA
  rev: 036332e96865994060159ac30d16dd5cdf29cc16  # this will be 0.5.0 in the future
  hooks:
   - id: nbqa-check-ast
     additional_dependencies: [pre-commit-hooks==3.3.0]

if you like - please do let us know if you run into any issues