Skip to main content

Jupyter bundler extension to export notebook as a docx file

Project description

Jupyter docx bundler extension

PyPi Version Conda Version

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 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. 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


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
jupyter_docx_bundler-0.1.3-py3-none-any.whl (4.7 kB) Copy SHA256 hash SHA256 Wheel py3
jupyter_docx_bundler-0.1.3.tar.gz (7.2 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page