Skip to main content

Launch an IPython Notebook from a template notebook file

Project description


Launch an IPython Notebook from a template notebook file.


Tested with:

  • Jupyter Notebook 5.5 (or higher)
  • Python 3.6

Should also work with other Python 3.x versions.


For general use, you can install nbkickoff using pip:

pip install nbkickoff

To upgrade to the latest version:

pip install -U nbkickoff

For local development:

git clone
cd nbkickoff
pip install -e .


Invoke using either the full:


Or, if the corresponding entry point script is on the PATH, the shorter version:


Here, TEMPLATEFILE is an IPython Notebook file that functions as a template. This file is copied to TARGETFILE (which must not exist yet), after which all variables in the notebook's cells are substituted with their corresponding values.

So, if your template notebook contains a cell with the text:

my_python_var = '{{ foo }}'

and you invoke nbkickoff using:

nbkickoff template.ipynb my_notebook.ipynb foo=bar

Then your shiny new notebook will have a cell containing:

my_python_var = 'bar'

If a suitable Jupyter server process is already running, nbkickoff opens the new notebook in the existing server. Otherwise, a new Jupyter server process is started. This behavior is based on that of the nbopen tool, with the notable change that nbkickoff always returns immediately; any newly spawned Jupyter server process is detached.

Project details

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for nbkickoff, version 0.1.0
Filename, size File type Python version Upload date Hashes
Filename, size nbkickoff-0.1.0-py3-none-any.whl (9.1 kB) File type Wheel Python version py3 Upload date Hashes View

Supported by

AWS AWS Cloud computing Datadog Datadog Monitoring Facebook / Instagram Facebook / Instagram PSF Sponsor Fastly Fastly CDN Google Google Object Storage and Download Analytics Huawei Huawei PSF Sponsor Microsoft Microsoft PSF Sponsor NVIDIA NVIDIA PSF Sponsor Pingdom Pingdom Monitoring Salesforce Salesforce PSF Sponsor Sentry Sentry Error logging StatusPage StatusPage Status page