Convert a Jupyter notebook to html output in native Python

Question

I know I can call

jupyter nbconvert --execute --to html notebook.ipynb

from shell, or do a system call from Python:

import os
os.system('jupyter nbconvert --execute --to html notebook.ipynb')

But having to do this with a system call when an nbconvert module is available in native Python seems very odd!

I want to write native python to execute and convert a iPython notebook to an html file. I studied the official documentation a little but couldn't piece things together. My questions are:

Is there an example to convert notebooks to html in native Python?
Is there a compelling reason not to do it?

JulianWgs · Accepted Answer · 2021-01-13 19:04:07Z

8

OK I figured out after some trial and error:

import nbformat
from nbconvert.preprocessors import ExecutePreprocessor
from nbconvert import HTMLExporter

# read source notebook
with open('report.ipynb') as f:
    nb = nbformat.read(f, as_version=4)

# execute notebook
ep = ExecutePreprocessor(timeout=-1, kernel_name='python3')
ep.preprocess(nb)

# export to html
html_exporter = HTMLExporter()
html_exporter.exclude_input = True
html_data, resources = html_exporter.from_notebook_node(nb)

# write to output file
with open("notebook.html", "w") as f:
    f.write(html_data)

Admittedly a lot more work than a single os.system call, but I'm surprised there are so little native python examples out there...

edited Jan 13, 2021 at 19:04

JulianWgs

1,0692 gold badges15 silver badges28 bronze badges

answered Dec 30, 2020 at 5:33

GZ-

2472 silver badges12 bronze badges

Sign up to request clarification or add additional context in comments.

1 Comment

JulianWgs Over a year ago

I had to set the encoding of the HTML-file to UTF-8: "with open("output/MEB_SKI_26_analysis.html", "w", encoding="utf") as f:"

Collectives™ on Stack Overflow

Convert a Jupyter notebook to html output in native Python

1 Answer 1

1 Comment

Your Answer

Hot Network Questions

Collectives™ on Stack Overflow

1 Answer 1

1 Comment

Your Answer

Sign up or log in

Post as a guest

Related