How to save Jupyter Notebook to HTML by code?

Question

I have a Jupyter Notebook program, which do analysis for me. After it's been run, I want to save it as HTML so I can view it later. (And then I can change the input data file to do analysis for other data.)

Typically, I do this by hand. This would look like

But this feels very tedious for me. So I'm wondering if there is any code can do this for me? Maybe something like

%save_html
# or with a file_name
%save_html file_name

Note: I have figured out a workaround for this. But I didn't find too much info by search, so I post it here and it may help someone else having the same problem. I'll post my solution as an answer.

waterproof · Accepted Answer · 2019-11-19 23:46:47Z

22

I'll give an answer myself.

from IPython.display import Javascript
from nbconvert import HTMLExporter

def save_notebook():
    display(
        Javascript("IPython.notebook.save_notebook()"),
        include=['application/javascript']
    )

def output_HTML(read_file, output_file):
    import codecs
    import nbformat
    exporter = HTMLExporter()
    # read_file is '.ipynb', output_file is '.html'
    output_notebook = nbformat.read(read_file, as_version=4)
    output, resources = exporter.from_notebook_node(output_notebook)
    codecs.open(output_file, 'w', encoding='utf-8').write(output)

In the last cell of the notebook, something like

import time

save_notebook()
time.sleep(3)
current_file = 'GMM.ipynb'
output_file = 'output_file.html'
output_HTML(current_file, output_file)

edited Nov 19, 2019 at 23:46

waterproof

5,1935 gold badges34 silver badges31 bronze badges

answered Jul 12, 2016 at 14:07

ZK Zhao

21.9k51 gold badges143 silver badges216 bronze badges

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

2 Comments

Alb Over a year ago

you forgot to import Javascript from Ipython.display before save_notebook()

KeepLearning Over a year ago

from IPython.display import Javascript

piRSquared · Accepted Answer · 2016-06-06 21:08:34Z

6

you should be able to find a script in the same directory that has the jupyter-notebook.exe file. Its name is jupyter-nbconvert.exe. Run it like this:

./jupyter-nbconvert.exe --to html 'path/to/nb.ipynb'`

Docs

answered Jun 6, 2016 at 21:08

piRSquared

296k68 gold badges509 silver badges654 bronze badges

Comments

P.Panayotov · Accepted Answer · 2018-06-11 12:13:44Z

3

First open console and go to directory where your notebook is.
Second enter this command:

ipython nbconvert --to HTML your_notebook.ipynb

After that you will have new file with name "your_notebook.html". Thats all.

You can check here for more information.

answered Jun 11, 2018 at 12:13

P.Panayotov

5735 silver badges8 bronze badges

Comments

lamoboos223 · Accepted Answer · 2020-06-27 23:52:24Z

3

just execute this snippet

!!jupyter nbconvert *.ipynb

answered Jun 27, 2020 at 23:52

lamoboos223

413 bronze badges

3 Comments

MD004 Over a year ago

This is a great solution. I use !!jupyter nbconvert MY_FILENAME.ipynb to only convert the one notebook. Note that it outputs MY_FILENAME.html. There doesn't appear to be a way to specify the output filename, so instead I use os.rename('MY_FILENAME.html', 'new_path/new_name.html') after generating the HTML file.

Rory L Over a year ago

From where? Within the notebook, or from a console?

MD004 Over a year ago

Use !!jupyter nbconvert MY_FILENAME.ipynb --to html in a code cell in the jupyter notebook. Be sure to save the notebook before running it.

Jasper Schwenzow · Accepted Answer · 2020-05-27 12:42:40Z

0

If you want a solution purely based on code, executed within the notebook, you can use the following short code snippet, which will name your file 'test_1':

a = 1
command = f'jupyter nbconvert Untitled.ipynb --output test_{a}.html'
subprocess.call(command)

edited May 27, 2020 at 12:42

answered Jan 30, 2020 at 6:33

Jasper Schwenzow

214 bronze badges

Collectives™ on Stack Overflow

How to save Jupyter Notebook to HTML by code?

5 Answers 5

2 Comments

Comments

Comments

3 Comments

Comments

Your Answer

Linked

Hot Network Questions

Collectives™ on Stack Overflow

5 Answers 5

2 Comments

Comments

Comments

3 Comments

Comments

Your Answer

Sign up or log in

Post as a guest

Linked

Related