Skip to main content

py2nb: convert python scripts to jupyter notebooks

Project description


convert python scripts to jupyter notebooks


Will Handley


PyPi location


py2nb is a python package for converting python scripts with minimal markdown to jupyter notebooks.

Markdown cells are rendered from comments beginning with #|, splits between code cells are created by comment lines beginning with #-

nb2py converts from jupyter notebooks to python


Users can install using pip:

pip install py2nb

from source:

git clone
cd py2nb
python install

or for those on Arch linux it is available on the AUR


If one has a script named containing the code:

#| # Testing ipython notebook
#| This is designed to demonstrate a simple script that converts a script into
#| a jupyter notebook with a simple additional markdown format.
#| Code by default will be put into code cells
#| * To make a markdown cell, prefix the comment line with with '#|' or '# |'
#| * To split a code cell, add a line beginning with '#-' or '# -'

import matplotlib.pyplot as plt
import numpy

%matplotlib inline

#| Here is a markdown cell.
#| Maths is also possible: $A=B$
#| There are code cells below, split by `'#-'`:

# | Here is another markdown cell

x = numpy.random.rand(5)


y = numpy.random.rand(4)
z = numpy.random.rand(3)

#| Here are some plots

x = numpy.linspace(-2,2,1000)
y = x**3
fig, ax = plt.subplots()

# -------------------------------

# | Here is another plot

x = np.linspace(-np.pi, np.pi, 201)
fig, ax = plt.subplots()

then running


produces the notebook example.ipynb

To do

  • evaluation option for script produced

  • vim syntax highlighting for markdown code blocks

Project details

Download files

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

Source Distribution

py2nb-1.0.0.tar.gz (3.7 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page