⚡ Bridging Interactive Notebooks and Production Scripts
While Jupyter notebooks excel at interactive data exploration, JSON-based `.ipynb` files complicate Git diffs and code reviews. Converting notebooks to pure Python `.py` scripts using `nbconvert` or maintaining live synchronization with `Jupytext` enables seamless CI/CD integration and production deployment.
1. Installing nbconvert and Jupytext Tools
Install the standard Jupyter conversion utility (`nbconvert`) and the advanced two-way synchronization tool (`Jupytext`).
Bash (Terminal)
# Install nbconvert and Jupytext via pip
pip install nbconvert jupytext
# Verify installations
jupyter nbconvert --version
jupytext --version
Successfully installed nbconvert-7.16.2 and jupytext-1.16.1. CLI commands verified.
2. Converting Jupyter Notebook (.ipynb) to Python Script (.py)
Use `jupyter nbconvert` to extract executable Python code from cell blocks while stripping out JSON metadata and notebook outputs.
Bash (Terminal Command)
# Convert notebook to standard Python script using script exporter
jupyter nbconvert --to script data_analysis_notebook.ipynb
# The command generates 'data_analysis_notebook.py' containing standard '# %%' cell markers.
[NbConvertApp] Converting notebook data_analysis_notebook.ipynb to script
[NbConvertApp] Writing 3450 bytes to data_analysis_notebook.py
3. Converting Python Script (.py) Back to Jupyter Notebook (.ipynb)
Reconstruct a fully functional interactive Jupyter notebook from a Python script formatted with cell demarcation headers.
Bash (Terminal Command)
# Convert a Python script back into an interactive notebook
jupyter nbconvert --to notebook data_analysis_notebook.py
# Alternatively using Jupytext
jupytext --to notebook data_analysis_notebook.py
[NbConvertApp] Converting notebook data_analysis_notebook.py to notebook
[NbConvertApp] Writing 4820 bytes to data_analysis_notebook.ipynb
4. Two-Way Live Synchronization Using Jupytext
Pair your `.ipynb` notebook with a corresponding `.py` script so that saving either file automatically updates the other.
Bash (Terminal Command)
# Pair notebook to maintain both .ipynb and .py files in sync
jupytext --set-formats ipynb,py:percent model_training.ipynb
# Saving changes in JupyterLab will now instantly update model_training.py on disk.
[jupytext] Reading model_training.ipynb
[jupytext] Writing model_training.py (percent format)
Pairing successfully configured for dual-format synchronization.
5. Automated Batch Conversion Python Script
Write a Python automation script to convert all Jupyter notebooks in a project directory into Python deployment scripts.
Python (Batch Conversion Script)
import glob
import subprocess
# Find all notebooks in the workspace directory
notebooks = glob.glob("*.ipynb")
for nb in notebooks:
print(f"Converting {nb} to Python script...")
subprocess.run(["jupyter", "nbconvert", "--to", "script", nb])
print("Batch conversion complete. All notebooks exported to .py scripts.")
Converting data_analysis_notebook.ipynb to Python script...
Converting model_training.ipynb to Python script...
Batch conversion complete. All notebooks exported to .py scripts.