nbexec is a dead-simple tool for executing Jupyter notebooks from the command line. It can run single notebooks, multiple notebooks, and/or an entire directory of notebooks in one short command.
nbexec runs your notebook using Jupyter's (browserless) nbconvert execution API. Then, if the notebook ran without errors, nbexec resaves the notebook in place.
Note: nbexec is in the early stages of development. Features may change/break in the future. Pinning your package installation to the current version is advised.
pip install nbexecTo run one notebook:
nbexec path/to/my/notebook.ipynbTo run multiple notebooks:
nbexec nb-one.ipynb foo/nb-two.ipynbTo run all notebooks in the first level of a directory:
nbexec path/to/directory-of-notebooksTo run all notebooks in the first three levels of a directory:
nbexec --max-depth 3 path/to/directory-of-notebooksusage: nbexec [-h] [--max-depth MAX_DEPTH] [--timeout TIMEOUT]
[--allow-iopub-timeout] [--record-timing]
[--kernel-name KERNEL_NAME] [--quiet] [--stdout]
notebooks [notebooks ...]
Execute Jupyter notebooks on the command line.
positional arguments:
notebooks One or more notebooks, or directories containing
notebooks.
optional arguments:
-h, --help show this help message and exit
--max-depth MAX_DEPTH
The number of directory levels to scan for notebooks.
(default: 1)
--timeout TIMEOUT How long to wait, in seconds, for any given notebook
cell to before raising an exception. (default: None)
--allow-iopub-timeout
Don't raise an error on IOPub timeouts. (default:
False)
--record-timing Store the execution timings in each cell's metadata.
(default: False)
--kernel-name KERNEL_NAME
The name of the kernel to use, e.g., 'python3'. If
None, nbexec uses the kernel specified in the
notebook. (default: None)
--quiet Don't print notifications, other than errors.
(default: False)
--stdout Instead of saving the notebook in place, pipe the
executed notebook to stdout. This option is not
available if you are executing multiple notebooks at
once. (default: False)
Note: nbexec uses Jupyter's nbconvert module. See
https://nbconvert.readthedocs.io/en/latest/execute_api.html for context.
- By default, do not record cell execution timings. (Use
--record-timingto record them.)
- By default, raise errors on IOPub timeouts. (Use
--allow-iopub-timeoutto prevent raising those errors.)
- Full test coverage
- [Your idea here]