nbmanips
A collections of utilities to manipulate IPython/Jupyter Notebooks via a python script.
I - Usage/Examples
1 - Basic usage
A simple example of using nbmanips:
# Read ipynb file
nb = Notebook.read_ipynb("my_notebook.ipynb")
# delete empty cells
nb.select("empty").delete()
# save ipynb file
nb.to_ipynb("new_notebook.ipynb")
Examples of operations you can perform on a Notebook:
replace: Replace matching text in the selected cellstag: Add metadata to the selected cellserase: Erase the content of the selected cellsdelete: Delete the selected cellskeep: Kepp the selected cells
2 - Selectors
To select cells on which to apply the previous operations, you can use:
- The cell number
# OR
nb.select(0).show()
- A slice object
# OR
selected_cells = slice(1, 6, 2)
nb.select(selected_cells).show()
-
A predefined selector. Available predefined selectors are the following:
code_cells/markdown_cells/raw_cells: Selects cells with the given typecontains: Selects Cells containing a certain text.is_empty/empty: Selects empty cellshas_output: Checks if the cell has any outputhas_output_type: Select cells that have a given output_typehas_slide_type: Select cells that have a given slide typeis_new_slide: Selects cells where a new slide/subslide startshas_byte_size: Selects cells with byte size within a given range of values.
# Show Cells containing the equal sign
nb.select('contains', '=').show()
- A function that takes a Cell object and returns True if the cell should be selected
nb.select(lambda cell: len(cell.source) > 10).show()
- A list of Selectors
nb.select(['markdown_cells', 'is_empty']).show()
# Show Markdown or Code Cells
nb.select(['markdown_cells', 'code_cells'], type='or').show()
3 - Export Formats
You can export the notebooks to these formats:
- to_ipynb
- to_dbc
- to_html
- to_slides (using reveal.js)
- to_md (to markdown)
- to_py (to python)
- to_text (textual representation of the notebook)
4 - Slide manipulations
You can manipulate the slides by tagging which cells to keep and which to skip. The following actions are available:
- set_slide
- set_subslide
- set_skip
- set_fragment
- set_notes
A neat trick is to use auto_slide method to automatically create slides out of your notebook:
# Read ipynb file
nb = Notebook.read_ipynb("my_notebook.ipynb")
# Automatically create slides
nb.auto_slide()
# Export to Reveal.js slides (HTML)
nb.to_slides("new_slides.slides.html", theme='beige')
II - CLI
1 - Show a notebook
To get a readable representation of the notebook
Other options are available. For example, you can customize the style, weather to truncate the output of cells:
To show a subset of the notebook cells, you can perform a select operation:
# Or if you're using negative indexes ( to show the last 3 cells )
nb select [-3:] | nb show my_notebook.ipynb
2 - Basic usage
A simple example of using nbmanips via the cli:
nb select empty | nb delete my_notebook.ipynb --output new_notebook.ipynb
# Or equivalently:
nbmanips select empty | nbmanips delete my_notebook.ipynb --output new_notebook.ipynb
You could also show the table of contents of a certain notebook:
Or split a notebook into multiple notebooks:
3 - Export Formats
You can convert a notebook to the following formats:
- html:
nb convert html my_notebook.ipynb --output my_notebook.html - slides (using reveal.js):
nb convert slides my_notebook.ipynb --output my_notebook.slides.html - md (to markdown):
nb convert md my_notebook.ipynb --output my_notebook.md - py (to python):
nb convert py my_notebook.ipynb --output my_notebook.py
4 - Slide manipulations
nb auto-slide -f my_notebook.ipynb
# Generate a my_notebook.slides.html file
nb convert slides my_notebook.ipynb
Or if you do not wish to modify your original notebook:
nb auto-slide my_notebook.ipynb -o my_temp_notebook.ipynb
# Generate a my_notebook.slides.html file
nb convert slides my_temp_notebook.ipynb -o my_notebook.slides.html
If you need more details you can check the --help option:
nbmanips --help
III - Optional Requirements
There are optional requirements you may want to install to render images in the terminal. The results, however, are not always convincing. If you want to enable this feature, you can just run the following command:
Roadmap
- Add Custom Templates