Import Jupyter notebooks using Margo notebook margin notebook syntax
Project description
margo-loader
Import computational Jupyter Notebooks notebooks as Python modules
Demo Notebook
Want to see Margo Loader in action before installing it? Here's a live demo notebook on Google Colaboratory.
Installation
To install margo-loader, run:
pip install git+https://github.com/margo-notebooks/margo-loader-py
Importing a notebook
Assuming you have a file called "notebook.ipynb" somewhere in your import path:
import margo_loader
import notebook
ignore-cell
Not every cell in a Notebook makes sense to include in its module representation.
If you want to prevent a cell from being exported, start the cell with the specially-formatted comment line # :: ignore-cell ::
, like this:
# :: ignore-cell ::
print("This code will not be executed when imported with margo-loader")
This special code comment is called a Margo note. Margo notes in Python cells begin with # ::
to differentiate them from regular comments, and end with ::
.
Learn more about the underlying Margo syntax here.
Creating virtual submodules
You can organize code cells into virtual submodules within
a notebook. This in effect allows you to group cells from the same notebook.
Here's an example of a few cells from the file
test_notebooks/greetings.ipynb
in this repo.
# greetings.ipynb
# :: submodule: "grumpy" ::
def say_hello(to="world"):
return f"Oh, uhh, hi {to}..."
# greetings.ipynb
# :: submodule: "nice" ::
def say_hello(to="world"):
return f"Hello, {to}! Nice to see you."
Notice we define the same say_hello
function twice. If the entire notebook
were imported, the second say_hello
would overwrite the first. However, we can
import either of these submodules or both using Python's standard import syntax once we
import margo_loader
.
>>> import margo_loader
>>> from test_notebooks.greetings import nice, grumpy
>>> nice.say_hello()
'Hello, world! Nice to see you.'
>>> grumpy.say_hello()
'Oh, uhh, hi world...'
>>>
Working with percent-formatted notebooks
This library works with Jupyter Notebooks (.ipynb files) as well as python files
with percent cell formatting using the file extension .pynb
. These are plain
source Python files that use # %%
to split the document into cells. Read more
here.
Look at test_notebooks/hello_notebook_pynb.pynb
in this repo for an example of
a code-cell notebook.
STABILITY NOTE: This is an alpha feature. The .pynb extension may be changed in a future version
Prior art
This project borrows its implementation approach from a Jupyter Notebook
documentation
example
that imports notebooks in their entirety as if they were .py
files. The key difference Margo Loader adds is use of Margo notes to create preoprocessor directives ignore-cell
and submodule
.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for margo_loader-0.0.2a0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | b8f210a4344bf76e525d7c8265a500137d37131ae0ef8ca04a8a0f8adb5b7a20 |
|
MD5 | f71f98021b0eb286b4d0c5d596eb4f4f |
|
BLAKE2b-256 | 7bb3d5d737db8a60f8d37f62ea197ac72ebdadda6bff768cc1c1245cfe33692a |