Using as a Python library¶
Jupytext provides the same
writes functions as
You can use
jupytext’s functions as drop-in replacements for
Reading notebooks from many text formats¶
To read text files as notebooks, simply provide the path to a Jupytext-supported format.
import jupytext # Read a notebook from a file ntbk = jupytext.read('notebook.md') # Read a notebook from a string jupytext.reads(text, fmt='md')
Jupytext will read in the content and infer metadata about the file from the YAML header (if there is one). If there is no Jupytext header, then Jupytext will make some assumptions about the format based on the file extension.
This function returns an instance of an
can find more information for working with this notebook representation
in the nbformat documentation.
Writing notebooks to many text files¶
You can also write in-memory notebooks to a variety of text formats by
Jupytext’s implementation provides an additional
which can be any of the accepted Jupytext extensions (e.g.,
If not explicitly provided, the argument is inferred from the file extension.
# Return the text representation of a notebook jupytext.writes(notebook, fmt='py:percent') # Write a notebook to a file in the desired format jupytext.write(notebook, 'notebook.py') jupytext.write(notebook, 'notebook.py', fmt='py:percent')