Jupyter bundler extension to export notebook as a docx file
Project description
Jupyter docx bundler extension
Jupyter bundler extension to export notebook as a docx file
Install
Installing with pip
Make sure you have Pandoc installed.
pip install jupyter_docx_bundler
jupyter bundlerextension enable --py jupyter_docx_bundler --sys-prefix
Installing with conda
conda install -c mrossi jupyter_docx_bundler
Usage
Adding Metadata
The bundle extension uses metadata of the notebook, if you you provide it.
- You can add a title by adding
"title": "Notebook title"
- You can add authors by adding
"authors": [{"name": "author1"}, {"name": "author2"}]
The notebook metadata can be edited under Edit -> Edit Notebook Metadata.
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
(Currently there are no default values configured for these tags, the ones listed above are defined in my code and not in nbconvert. This may will change in the future.)
Cell tags can be shown by activating the cell toolbar under View -> Cell Toolbar -> Tags.
Development
Testing
The package is tested with pytest.
Building
To build the package with conda-build you need to call
conda-build -c defaults -c conda-forge conda.recipe
The additional channel conda-forge is necessary because the package Pandoc is only available there in a recent version.
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 jupyter_docx_bundler-0.1.3.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 5c05092ce9efe68550dc32ebe5410d13f0f4813b59dbe21e95d73b7893f26a0f |
|
MD5 | 52c5c57400f444376bbe50de7ba39ef6 |
|
BLAKE2b-256 | 1f7d389c909ebcfe612eb762bb14c9a4492bf99efcffa7c3ea80a26eec6d256e |
Hashes for jupyter_docx_bundler-0.1.3-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 82f79d0a227dd2eb2b5cc00c05127a919cc460044aade2a4de9e8eb6b4f1f413 |
|
MD5 | 91a352bfa881fccd35372ee8629ac985 |
|
BLAKE2b-256 | 6b69a58d02f2adcabd36a5b1ff1b4dc75f038260fae8a5f5d027c4f5ed5c5e13 |