Skip to content

Instantly share code, notes, and snippets.

What would you like to do?
Run a Set of Jupyter Notebooks from the Command Line
# ! python
# coding: utf-8
import os
import argparse
import glob
import nbformat
from nbconvert.preprocessors import ExecutePreprocessor
from nbconvert.preprocessors.execute import CellExecutionError
# Parse args
parser = argparse.ArgumentParser(description="Runs a set of Jupyter \
file_text = """ Notebook file(s) to be run, e.g. '*.ipynb' (default),
'my_nb1.ipynb', 'my_nb1.ipynb my_nb2.ipynb', 'my_dir/*.ipynb'
parser.add_argument('file_list', metavar='F', type=str, nargs='*',
parser.add_argument('-t', '--timeout', help='Length of time (in secs) a cell \
can run before raising TimeoutError (default 600).', default=600,
parser.add_argument('-p', '--run-path', help='The path the notebook will be \
run from (default pwd).', default='.', required=False)
args = parser.parse_args()
print('Args:', args)
if not args.file_list: # Default file_list
args.file_list = glob.glob('*.ipynb')
# Check list of notebooks
notebooks = []
print('Notebooks to run:')
for f in args.file_list:
# Find notebooks but not notebooks previously output from this script
if f.endswith('.ipynb') and not f.endswith('_out.ipynb'):
notebooks.append(f[:-6]) # Want the filename without '.ipynb'
# Execute notebooks and output
num_notebooks = len(notebooks)
for i, n in enumerate(notebooks):
n_out = n + '_out'
with open(n + '.ipynb') as f:
nb =, as_version=4)
ep = ExecutePreprocessor(timeout=int(args.timeout), kernel_name='python3')
print('Running', n, ':', i, '/', num_notebooks)
out = ep.preprocess(nb, {'metadata': {'path': args.run_path}})
except CellExecutionError:
out = None
msg = 'Error executing the notebook "%s".\n' % n
msg += 'See notebook "%s" for the traceback.' % n_out
except TimeoutError:
msg = 'Timeout executing the notebook "%s".\n' % n
# Write output file
with open(n_out + '.ipynb', mode='wt') as f:
nbformat.write(nb, f)
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment