Report generation (notebooks to HTML/PDF) in Data Analysis Python - Step-by-Step Execution

Concept Flow - Report generation (notebooks to HTML/PDF)

Write notebook code

↓

Run notebook cells

↓

Export notebook

↓

To HTML

↓

To PDF

↓

View or share report

You write and run code in a notebook, then export it as HTML or PDF to create a shareable report.

Execution Sample

Data Analysis Python

import nbformat
from nbconvert import HTMLExporter

with open('analysis.ipynb') as f:
    nb = nbformat.read(f, as_version=4)
html_exporter = HTMLExporter()
(body, resources) = html_exporter.from_notebook_node(nb)
with open('report.html', 'w') as f:
    f.write(body)

This code reads a notebook file and converts it to an HTML report file.

Execution Table

Step	Action	Input	Output	Notes
1	Read notebook file	'analysis.ipynb'	Notebook object	Loads notebook content into memory
2	Create HTML exporter	None	HTMLExporter instance	Prepares exporter for HTML format
3	Convert notebook to HTML	Notebook object	HTML string, resources	Transforms notebook cells to HTML
4	Write HTML to file	HTML string	'report.html' file	Saves the HTML report to disk
5	Open 'report.html'	File	Rendered report in browser	User views the report
6	Export to PDF (optional)	Notebook or HTML	PDF file	Alternative report format
7	Share report	HTML or PDF file	Shared report	Send or publish report
Exit	Process complete	Report file created	Report ready	End of report generation

💡 Report file created and ready for viewing or sharing

Variable Tracker

Variable	Start	After Step 1	After Step 3	After Step 4	Final
nb	None	Notebook object loaded	Same notebook object	Same notebook object	Same notebook object
html_exporter	None	None	HTMLExporter instance	HTMLExporter instance	HTMLExporter instance
body	None	None	HTML string	HTML string	HTML string
resources	None	None	Resources dict	Resources dict	Resources dict

Key Moments - 3 Insights

Why do we need to read the notebook file before exporting?

The notebook file contains the code and outputs. Reading it loads this content into memory so the exporter can convert it, as shown in Step 1 and Step 3 of the execution table.

Can we export directly to PDF from the notebook object?

Yes, but often the notebook is first converted to HTML or another format, then to PDF. Step 6 shows PDF export as an optional step after HTML export.

What happens if we don't write the HTML string to a file?

The report won't be saved and can't be viewed later. Step 4 writes the HTML string to 'report.html' so it can be opened and shared.

Visual Quiz - 3 Questions

Look at the execution table, what is the output after Step 3?

A HTML string and resources

B Notebook object

C HTMLExporter instance

D Report file

💡 Hint

Check the 'Output' column for Step 3 in the execution table.

At which step is the HTML report saved to disk?

A Step 2

B Step 3

C Step 4

D Step 5

💡 Hint

Look for the action 'Write HTML to file' in the execution table.

If we skip Step 1, what will happen in Step 3?

A HTMLExporter will create a notebook object automatically

B Conversion will fail due to missing notebook object

C An empty HTML file will be created

D The report will be saved as PDF instead

💡 Hint

Step 1 loads the notebook; without it, Step 3 has no input to convert.

Concept Snapshot

Report generation from notebooks:
- Load notebook file with nbformat
- Use nbconvert exporters (HTMLExporter, PDFExporter)
- Convert notebook object to desired format
- Save output to file
- Share or view report
Key: Reading notebook first, then exporting

Full Transcript

Report generation from notebooks involves reading the notebook file into memory, then using exporters like HTMLExporter to convert the notebook content into HTML or PDF formats. The process starts by loading the notebook file, then creating an exporter instance. Next, the notebook is converted to the target format, producing a string or file content. This output is saved to a file, such as 'report.html', which can be opened in a browser or shared. Optionally, the report can be exported as PDF. Each step depends on the previous, so skipping reading the notebook will cause conversion to fail. This step-by-step process ensures the notebook's code, outputs, and markdown are preserved in a shareable report.

Practice

1. What is the main purpose of using jupyter nbconvert in data science?

easy

A. To convert Jupyter notebooks into HTML or PDF reports for easy sharing

B. To run Python code faster inside notebooks

C. To create new Jupyter notebooks automatically

D. To debug errors in Python code within notebooks

Solution

1. Step 1: Understand the function of nbconvert

   jupyter nbconvert is a tool that converts notebooks into other formats like HTML or PDF.

2. Step 2: Identify the main benefit

   Converting notebooks to HTML or PDF helps share results with people who don't use Jupyter notebooks.

3. Final Answer:

   To convert Jupyter notebooks into HTML or PDF reports for easy sharing -> Option A

4. Quick Check:

   nbconvert purpose = convert notebooks to shareable reports [OK]

Hint: Remember nbconvert = notebook to report file [OK]

Common Mistakes:

• Thinking nbconvert runs code faster
• Confusing nbconvert with notebook creation
• Assuming nbconvert is for debugging

2. Which of the following is the correct command to convert a notebook named analysis.ipynb to an HTML file using the terminal?

easy

A. jupyter convert --to html analysis.ipynb

B. jupyter nbconvert --to html analysis.ipynb

C. nbconvert --convert html analysis.ipynb

D. jupyter nbconvert analysis.ipynb --html

Solution

1. Step 1: Recall the correct nbconvert syntax

   The correct command uses jupyter nbconvert --to html filename.ipynb.

2. Step 2: Match the command to options

   jupyter nbconvert --to html analysis.ipynb matches the correct syntax exactly.

3. Final Answer:

   jupyter nbconvert --to html analysis.ipynb -> Option B

4. Quick Check:

   Correct nbconvert syntax = jupyter nbconvert --to html analysis.ipynb [OK]

Hint: Use '--to html' right after nbconvert [OK]

Common Mistakes:

• Using 'jupyter convert' instead of 'jupyter nbconvert'
• Placing options in wrong order
• Using '--html' instead of '--to html'

3. Consider this Python code snippet to convert a notebook to PDF programmatically:

import os
os.system('jupyter nbconvert --to pdf report.ipynb')

What will be the output after running this code if report.ipynb exists and conversion succeeds?

medium

A. Nothing happens; the command runs silently without output

B. The notebook report.ipynb is deleted

C. An error message about missing PDF converter appears

D. A PDF file named report.pdf is created in the current directory

Solution

1. Step 1: Understand os.system command

   The command runs jupyter nbconvert --to pdf report.ipynb in the terminal from Python.

2. Step 2: Know nbconvert PDF output behavior

   If the notebook exists and conversion works, a PDF file report.pdf is created in the same folder.

3. Final Answer:

   A PDF file named report.pdf is created in the current directory -> Option D

4. Quick Check:

   nbconvert PDF output = report.pdf file created [OK]

Hint: nbconvert creates output file with same base name [OK]

Common Mistakes:

• Thinking the notebook file is deleted
• Expecting no output file
• Assuming error without checking converter installation

4. You run this command in terminal:
jupyter nbconvert --to pdf my_notebook.ipynb
but get an error saying PDF conversion failed: 'xelatex' not found.
What is the most likely fix?

medium

A. Install a LaTeX distribution like TeX Live or MiKTeX on your system

B. Rename the notebook file to have a .pdf extension

C. Run the command with --to html instead of pdf

D. Update Jupyter to the latest version

Solution

1. Step 1: Understand the error message

   The error says xelatex is missing, which is a LaTeX tool needed for PDF conversion.

2. Step 2: Identify the fix

   Installing a LaTeX distribution like TeX Live or MiKTeX provides xelatex and fixes the error.

3. Final Answer:

   Install a LaTeX distribution like TeX Live or MiKTeX on your system -> Option A

4. Quick Check:

   Missing xelatex = install LaTeX distribution [OK]

Hint: PDF needs LaTeX; install it if missing [OK]

Common Mistakes:

• Renaming files instead of installing LaTeX
• Switching to HTML without reason
• Assuming Jupyter update fixes LaTeX errors

5. You want to automate generating HTML reports from multiple notebooks in a folder using Python. Which code snippet correctly converts all .ipynb files to HTML?

hard

A. import os
for file in os.listdir():
os.system(f'jupyter nbconvert --to html "{file}"')

B. import os
for file in os.listdir():
if file.endswith('.html'):
os.system(f'jupyter nbconvert --to ipynb "{file}"')

C. import os
for file in os.listdir():
if file.endswith('.ipynb'):
os.system(f'jupyter nbconvert --to html "{file}"')

D. import os
for file in os.listdir():
if file.endswith('.ipynb'):
os.system(f'jupyter convert --to html "{file}"')

Solution

1. Step 1: Filter files with .ipynb extension

   We want to convert only notebook files, so check if filename ends with '.ipynb'.

2. Step 2: Use correct nbconvert command inside loop

   Use jupyter nbconvert --to html "{file}" to convert each notebook to HTML.

3. Final Answer:

   import os for file in os.listdir(): if file.endswith('.ipynb'): os.system(f'jupyter nbconvert --to html "{file}"') -> Option C

4. Quick Check:

   Filter .ipynb and run nbconvert to html [OK]

Hint: Check file extension before converting [OK]

Common Mistakes:

• Trying to convert .html files instead of .ipynb
• Missing file extension check causing errors
• Using wrong command 'jupyter convert' instead of 'nbconvert'