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 from git
```
git clone https://github.com/m-rossi/jupyter_docx_bundler.git
cd jupyter_docx_bundler
pip install .
jupyter bundlerextension enable --py jupyter_docx_bundler --sys-prefix
```
## Usage
### Adding Metadata
The bundle extension uses metadata of the notebook, if you you provide it.
* You can add a title by adding `"name": "Notebook name"`
* 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 cell
* `nbconvert-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](https://github.com/jupyter/nbconvert). This may will change in the future.)_
Cell tags can be shown by activating the cell toolbar under _View_ -> _Cell Toolbar_ -> _Tags_.
Jupyter bundler extension to export notebook as a docx file
## Install
### Installing from git
```
git clone https://github.com/m-rossi/jupyter_docx_bundler.git
cd jupyter_docx_bundler
pip install .
jupyter bundlerextension enable --py jupyter_docx_bundler --sys-prefix
```
## Usage
### Adding Metadata
The bundle extension uses metadata of the notebook, if you you provide it.
* You can add a title by adding `"name": "Notebook name"`
* 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 cell
* `nbconvert-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](https://github.com/jupyter/nbconvert). This may will change in the future.)_
Cell tags can be shown by activating the cell toolbar under _View_ -> _Cell Toolbar_ -> _Tags_.
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
Close
Hashes for jupyter_docx_bundler-0.1.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | f52a9cb23b96a2cf7b7932cbec2fd7daa82450ada52421bc002a8284384fe4bf |
|
MD5 | 119c26041c451abf32b548c89f6f0ec9 |
|
BLAKE2b-256 | 462ad0f05395607d00bd18895a69766383e4e97bb19b5cb7e7989a6b2cc68788 |
Close
Hashes for jupyter_docx_bundler-0.1.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | cf321e866fd703168f2eadd59d887d2681ee27bceeced7c3226342adf469d89e |
|
MD5 | d56d30d4f5ab447c29373866f7bbe80b |
|
BLAKE2b-256 | 1cfa79180071ae5e198da04540d77f1abcc5d0c4baf4a22cf74669cb461cbb1a |