Don't let notebook cells run out of order
Project description
enforce-notebook-run-order
Enforce the run order of Jupyter notebooks.
Jupyter notebooks are great for interactive data analysis. However, when they can encourage a bad habit: running cells out of order. This can lead to notebooks being committed to the repository in a state where they don't run from top to bottom, and other collaborators may receive different results when running the notebook from top to bottom.
enforce-notebook-run-order
enforces the run order of a notebook by
raising an exception if any cells are run out of order.
Installation
enforce-notebook-run-order
can be installed via pip:
pip install enforce-notebook-run-order
It can also be set up as a pre-commit hook. See the pre-commit hook section for more details.
Usage
enforce-notebook-run-order
can be used as a standalone script, or as a
pre-commit hook.
Standalone
To use enforce-notebook-run-order
as a standalone script, simply run
it with the path to the notebook(s) you want to check:
nbcheck my_notebook.ipynb my_other_notebook.ipynb
Or point it to a directory to check all notebooks in that directory:
nbcheck my_notebooks/
If no paths are specified, nbcheck
will check all notebooks in the
current directory.
You can also use the full enforce-notebook-run-order
command, but the
nbcheck
command is provided as a convenience.
pre-commit hook
To use enforce_notebook_run_order
as a pre-commit hook, add the
following to your .pre-commit-config.yaml
:
repos:
- repo: https://github.com/christopher-hacker/enforce-notebook-run-order
rev: 1.7.0
hooks:
- id: enforce-notebook-run-order
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for enforce_notebook_run_order-1.7.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 6371f8232d1b3c5ecf74f6077b7ff8cbd092899c6a78b5b255ec8ba7d250bf36 |
|
MD5 | 83c5b2a9a8e94506fa751efbd0327807 |
|
BLAKE2b-256 | 63235a47a5b3a508afc90b79bb2362133d9473755a93253227ad9bd3bcb0f795 |
Hashes for enforce_notebook_run_order-1.7.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | df0e23da1d136388477bb217e350980d522c97c51545778d8c3e13c54ace9e91 |
|
MD5 | 633f8537547d7051e37794745c3122fb |
|
BLAKE2b-256 | a6f16b436682445f09c3b0dbb016ac2d2bbe2180e0b7a43a0900301042cb79cc |