Skip to main content
Help the Python Software Foundation raise $60,000 USD by December 31st!  Building the PSF Q4 Fundraiser

Embed pandas DataFrames as images in pdf and markdown files when converting from Jupyter Notebooks

Project description

dataframe_image

A package to convert Jupyter Notebooks to either PDF or Markdown documents with the following extra functionality not provided directly by nbconvert:

  • Embedding pandas DataFrames into the final PDF or Markdown as they appear in the notebook
  • Downloading the notebook as a PDF appearing exactly as it does in your browser (using the print as PDF feature from chrome)
  • Extracting all images in markdown (inline, reference, attachments, and <img> tags)
  • Allowing the new document to be saved anywhere in your filesystem and correctly linking to resources

Motivation

When converting Jupyter Notebooks to pdf using nbconvert, pandas DataFrames appear as either raw text or as a simple latex table as seen on the left side of the image below.

png

This package was first created to embed DataFrames into pdf and markdown documents as images so that they appear exactly as they do in a Jupyter Notebook, as seen on the right side of the image above. It has since added much more functionality.

Installation

pip install dataframe_image

Usage

There are three different ways to use dataframe_image:

  • Within a Jupyter Notebook
  • As a Python library
  • From the command line

To get access to all of the available options, use it as a library or from the command line. Using it within the notebook allows you to download the notebook as PDF via latex or via the browser.

Within a Jupyter Notebook

Upon installation, two new options will appear in your Jupyter Notebook under File -> Download as -> PDF - DataFrame as Image (via latex) and PDF - DataFrame as Image (via browser). Each option produces a distinctly different output. Using latex, a formal report with numbered sections will be returned. Using the browser, you'll get a near replica of how the notebook appears in your browser.

The conversion process is time consuming as screenshots of each DataFrame will be taken and then embedded into a pdf. A new blank tab will open during the processing. It will appear as nothing is happening. When processing is complete, the document will be downloaded. Converting via browser is significantly faster as it uses chromes built-in print-to-pdf capabilities.

When using this option, the notebook will NOT be executed. Make sure to execute the notebook first.

png

As a Python Library

In a separate Python script, import the dataframe_image package and pass the file name of your notebook to the convert function. By default, a PDF using latex will be produced. Set the use option to 'browser' to get the other version. Using dataframe_image as a Python library provides you with all of the available options, including downloading as a Markdown document.

>>> import dataframe_image as dfi
>>> dfi.convert('path/to/your_notebook.ipynb',
                to='pdf',
                use='latex',
                latex_command=None,
                max_rows=30,
                max_cols=10,
                ss_width=1000,
                ss_height=900,
                resize=1,
                chrome_path=None,
                limit=None,
                document_name=None,
                execute=True,
                save_notebook=False,
                output_dir=None,
                image_dir_name=None
                )

By default, the new file(s) will be saved in the same directory where the notebook resides.

Do not run this command within the same notebook that is being converted.

From the Command Line

The command line tool dataframe_image will be available upon installation with the same options as the convert function from above.

dataframe_image --to=pdf "my notebook with dataframes.ipynb"

Finding Google Chrome

You must have Google Chrome (or Brave) installed in order for dataframe_image to work. The path to Chrome will automatically be found. If Chrome is not in a standard location, set it with the chrome_path parameter.

Publish to Medium (upcoming)

You can publish your notebooks as Medium blog posts by installing the jupyter_to_medium package.

Extras

This package also embeds any images added to markdown cells as attachments (done by dragging and dropping the image) as well as those referenced by HTML <img> tags. It is also able to properly save the pdf/markdown and its images in a directory outside of where it is located.

Dependencies

You must have the following python libraries installed:

Installing LaTeX

It is possible to use dataframe_image without a latex installation as long as you only download pdfs via browser. Consult nbconvert's documentation to learn how to get latex installed correctly on your machine.

Project details


Download files

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

Files for dataframe-image, version 0.0.10
Filename, size File type Python version Upload date Hashes
Filename, size dataframe_image-0.0.10-py3-none-any.whl (21.1 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size dataframe_image-0.0.10.tar.gz (17.4 kB) File type Source Python version None Upload date Hashes View

Supported by

Pingdom Pingdom Monitoring Google Google Object Storage and Download Analytics Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page