Jupyter bundler extension to export notebook as a docx file
Last updated Apr 16, 2025
38
Stars
7
Forks
7
Issues
0
Stars/day
Attention Score
18
Language breakdown
No language data available.
▸ Files
click to expand
README
Jupyter docx bundler extension
Jupyter bundler extension to export notebook as a docx file
Installation
Using conda
conda install -c conda-forge jupyter-docx-bundler
Using pip
Make sure you have Pandoc installed, see installing-pandoc for instructions.
pip install jupyter-docx-bundler
Usage
Adding Metadata
The bundle extension uses metadata of the notebook, if you you provide it.
"title": "Notebook title""authors": [{"name": "author1"}, {"name": "author2"}]"subtitle": "Notebook subtitle""date": "Notebook date"
Hiding inputs or complete code cells
You can hide individual code cells or just their inputs by defining cell tags:
nbconvert-remove-cell: Remove the entire cellnbconvert-remove-input: Remove the input code of the cell
Cell tags can be shown by activating the cell toolbar under View -> Cell Toolbar -> Tags.
Hiding all inputs
It is also possible to hide all inputs. To achive this you need to add the following lines to your notebook metadata:
{
"jupyter-docx-bundler": {
"exclude_input": "True"
}
}
The notebook metadata can be edited under Edit -> Edit Notebook Metadata.
Direct call from console (nbconvert)
To use the bundler direct from console the nbconvert utility can be used with target format docx:
jupyter nbconvert --execute --to=docx <source notebook>.ipynb --output <target document>.docx
--execute option should be used to ensure that the notebook is run before generation.
Development
See CONTRIBUTING
🔗 More in this category