jupytext

Turn a notebook into a paired .ipynb/.py notebook

$ jupytext --set-formats ipynb,py [notebook.ipynb]

$ jupytext --to py [notebook.ipynb]

$ jupytext --to notebook [notebook.py]

$ jupytext --to notebook --execute [notebook.md]

$ jupytext --update --to notebook [notebook.py]

$ jupytext --sync [notebook.ipynb]

jupytext [options]

--to
    Convert notebook to the specified format (e.g., markdown, python).

--update
    Update the paired representation of the notebook.

--test
    Test if the notebook is well paired with its representation.

--sync
    Synchronize the paired representation of the notebook.

--set-formats
    Set the jupytext formats for notebook.

--help
    Show help message and exit.

--version
    Show version information and exit.

Jupytext is a command-line tool and Python package that allows you to work with Jupyter Notebooks as plain text files, such as Markdown, R Markdown, and Python scripts. This enables you to manage notebooks in version control systems more easily, collaborate with colleagues who prefer text-based formats, and use your favorite text editor to edit Jupyter notebooks.

Jupytext essentially synchronizes a Jupyter Notebook (.ipynb) file with a text-based representation (e.g., .md, .py). Changes made in either file are reflected in the other. This is useful for ensuring both human-readable and executable versions of your notebooks are always up-to-date. It provides a flexible solution for managing and converting between these formats. Jupytext can be installed via pip and used from the command line or within a Jupyter environment.

Jupytext works by 'pairing' a Jupyter Notebook with a text representation. You can configure how the pairing works by specifying the formats in the Jupyter Notebook metadata. This allows you to define exactly which text formats are associated with a given notebook.

Some key use cases are:
1. Version control of notebooks in text-based formats.
2. Collaborative editing of notebooks with text editors.
3. Running jupyter notebooks as python scripts.

jupyter(1), nbconvert(1)