Skip to main content

Jupyter extension to export notebooks as PDFs

Project description

Jupyter Notebooks as PDF

Binder

This Jupyter notebook extension allows you to save your notebook as a PDF.

Three new features compared to the official "save as PDF" extension:

  1. produce a PDF with the smallest number of page breaks,
  2. the original notebook is attached to the PDF; and
  3. this extension does not require LaTex.

The created PDF will have as few pages as possible, in many cases only one. This is useful if you are exporting your notebook to a PDF for sharing with others who will view it on a screen.

To make it easier to reproduce the contents of the PDF at a later date the original notebook is attached to the PDF. Unfortunately not all PDF viewers know how to deal with attachments. PDF viewers known to support downloading of file attachments are: Acrobat Reader, pdf.js and evince. The pdftk CLI program can also extract attached files from a PDF. Preview for OSX does not know how to display/give you access to attachments of PDF files.

Install

To use this bundler you need to install it:

python -m pip install -U notebook-as-pdf
pyppeteer-install

The second command will download and setup Chromium. It is used to perform the HTML to PDF conversion.

On linux you probably also need to install some or all of the APT packages listed in binder/apt.txt.

Use it

Create a notebook and the click "File -> Download As". Click the new menu entry called "PDF via HTML". Your notebook will be converted to a PDF on the fly and then downloaded.

You can also use it with nbconvert:

jupyter-nbconvert --to PDFviaHTML example.ipynb

which will create a file called example.pdf.

You will have to use Acrobat Reader to see the attachment to your PDF. Preview on OSX can not display PDF attachments.

Project details


Download files

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

Source Distribution

notebook-as-pdf-0.3.0.tar.gz (4.9 kB view details)

Uploaded Source

Built Distribution

notebook_as_pdf-0.3.0-py3-none-any.whl (6.1 kB view details)

Uploaded Python 3

File details

Details for the file notebook-as-pdf-0.3.0.tar.gz.

File metadata

  • Download URL: notebook-as-pdf-0.3.0.tar.gz
  • Upload date:
  • Size: 4.9 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for notebook-as-pdf-0.3.0.tar.gz
Algorithm Hash digest
SHA256 320f9b1eb76586be4de66c1e856b2c9a6d584ad3a922eefd179648f2bacba5f5
MD5 3a458905e7f9738a4801b7ef4386aeda
BLAKE2b-256 0bd26d15c8d72879cec8631fd516dd6ccb88b84a81decda226d9e77094a7a9ac

See more details on using hashes here.

File details

Details for the file notebook_as_pdf-0.3.0-py3-none-any.whl.

File metadata

  • Download URL: notebook_as_pdf-0.3.0-py3-none-any.whl
  • Upload date:
  • Size: 6.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.23.0 setuptools/46.1.3.post20200325 requests-toolbelt/0.9.1 tqdm/4.45.0 CPython/3.8.2

File hashes

Hashes for notebook_as_pdf-0.3.0-py3-none-any.whl
Algorithm Hash digest
SHA256 ac66647695a8a9b295f07aaf2090059415f7fbdfdb888fe282c6f4fce681a98f
MD5 7d28532bcb88261e89c36860647a1a88
BLAKE2b-256 42f0126f7706f413eba4c96682d3b8584e84041d572f5b52d6b3c95d09326151

See more details on using hashes here.

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page