Skip to main content

Launch an IPython Notebook from a template notebook file

Project description

nbkickoff

Launch an IPython Notebook from a template notebook file.

Requirements

Tested with:

  • Jupyter Notebook 5.5 (or higher)
  • Python 3.6

Should also work with other Python 3.x versions.

Installation

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 https://github.com/lumicks/nbkickoff.git
cd nbkickoff
pip install -e .

Usage

Invoke using either the full:

python -m nbkickoff TEMPLATEFILE TARGETFILE [VAR=VALUE [VAR2=VALUE ...]]

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

nbkickoff TEMPLATEFILE TARGETFILE [VAR=VALUE [VAR2=VALUE ...]]

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


Release history Release notifications

This version
History Node

0.1.0

Download files

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

Filename, size & hash SHA256 hash help File type Python version Upload date
nbkickoff-0.1.0-py3-none-any.whl (9.1 kB) Copy SHA256 hash SHA256 Wheel py3 Jun 15, 2018

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging CloudAMQP CloudAMQP RabbitMQ AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page