Report generation (notebooks to HTML/PDF) in Data Analysis Python - Cheat Sheet & Quick Revision

Recall & Review

beginner

What is the main purpose of converting Jupyter notebooks to HTML or PDF?

To create a shareable, readable report that can be viewed without needing the notebook environment. HTML is good for interactive viewing in browsers, and PDF is good for printing or offline reading.

beginner

Which command line tool is commonly used to convert Jupyter notebooks to HTML or PDF?

The tool is nbconvert, which is part of Jupyter. It can convert notebooks to many formats including HTML and PDF.

beginner

What is the basic command to convert a notebook named analysis.ipynb to HTML using nbconvert?

jupyter nbconvert --to html analysis.ipynb

This creates an HTML file from the notebook.

intermediate

How can you generate a PDF report from a notebook using nbconvert?

Use the command

jupyter nbconvert --to pdf notebook.ipynb

. This converts the notebook to PDF, often using LaTeX behind the scenes.

intermediate

Why might you want to clean or clear output cells before converting a notebook to a report?

Clearing outputs removes old results so the report shows fresh results or is smaller in size. It helps avoid confusion if outputs are outdated or irrelevant.

Which format is best for interactive viewing of a notebook report in a web browser?

A HTML

B PDF

C Markdown

D CSV

HTML supports interactive elements and can be opened easily in any web browser.

What command converts a notebook to PDF using Jupyter nbconvert?

A jupyter notebook --export pdf

B jupyter convert --pdf notebook.ipynb

C jupyter nbconvert --to pdf notebook.ipynb

D nbconvert --html notebook.ipynb

The correct syntax uses 'jupyter nbconvert --to pdf' followed by the notebook filename.

What is a common reason to clear outputs before exporting a notebook?

A To add more code cells

B To reduce file size and avoid showing outdated results

C To change the notebook theme

D To convert code to markdown

Clearing outputs removes old results, making the report cleaner and smaller.

Which tool is part of Jupyter and used for notebook conversion?

A matplotlib

B pandas

C scikit-learn

D nbconvert

nbconvert is the Jupyter tool designed for converting notebooks to other formats.

If you want to share a notebook report that can be printed easily, which format should you choose?

A PDF

B HTML

C JSON

D Python script

PDF is the best format for printing and offline reading.

Explain the steps to convert a Jupyter notebook into a PDF report using command line tools.

Think about the command syntax and what happens behind the scenes.

Describe why and when you would clear outputs in a notebook before generating a report.

Consider the clarity and size of the final 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'