Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jsvine/nbexec
A dead-simple tool for executing Jupyter notebooks from the command line.
https://github.com/jsvine/nbexec
jupyter notebook
Last synced: 4 months ago
JSON representation
A dead-simple tool for executing Jupyter notebooks from the command line.
- Host: GitHub
- URL: https://github.com/jsvine/nbexec
- Owner: jsvine
- License: mit
- Created: 2018-04-29T13:57:39.000Z (almost 7 years ago)
- Default Branch: master
- Last Pushed: 2023-02-11T02:06:03.000Z (about 2 years ago)
- Last Synced: 2024-10-13T11:28:50.159Z (4 months ago)
- Topics: jupyter, notebook
- Language: Python
- Size: 111 KB
- Stars: 20
- Watchers: 3
- Forks: 0
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE.txt
Awesome Lists containing this project
README
[](https://pypi.python.org/pypi/nbexec) [](https://pypi.python.org/pypi/nbexec)
# nbexec
`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](http://nbconvert.readthedocs.io/en/latest/execute_api.html). 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.
## Installation
```sh
pip install nbexec
```
## Basic usage
To run one notebook:
``` sh
nbexec path/to/my/notebook.ipynb
```
To run multiple notebooks:
``` sh
nbexec nb-one.ipynb foo/nb-two.ipynb
```
To run all notebooks in the first level of a directory:
``` sh
nbexec path/to/directory-of-notebooks
```
To run all notebooks in the first three levels of a directory:
``` sh
nbexec --max-depth 3 path/to/directory-of-notebooks
```
## Command-line options
```
usage: 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.
```
## Changelog
### v0.2.0
- By default, do not record cell execution timings. (Use `--record-timing` to record them.)
### v0.1.0
- By default, raise errors on IOPub timeouts. (Use `--allow-iopub-timeout` to prevent raising those errors.)
## Possible future features / improvements
- [ ] Full test coverage
- [ ] [Your idea here]