Skip to main content

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

Project description

dataframe_image

A package to embed pandas DataFrames as images when converting Jupyter Notebooks to pdf or markdown documents.

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

Installation

pip install dataframe_image

Usage

In a separate Python script, import the dataframe_image package and pass the file name of your notebook to the convert function.

>>> import dataframe_image as dfi
>>> dfi.convert('path/to/your_notebook.ipynb',
                to='pdf',
                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
                )

The new file(s) will be saved in the same directory where the notebook resides. dataframe_image will automatically find the location of chrome on Windows, macOS, and Linux. Set the to parameter to 'md' to convert to markdown.

Download directly from a notebook

You can download your pdf/markdown file by navigating to the File -> Download as -> PDF - DataFrame as Image

Command line tool

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"

Publish to Medium

You can publish your notebooks as Medium blog posts by installing the jupyter_to_medium package which first converts your notebook to markdown using dataframe_image.

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

You must also have Google Chrome installed.

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.6
Filename, size File type Python version Upload date Hashes
Filename, size dataframe_image-0.0.6-py3-none-any.whl (15.6 kB) File type Wheel Python version py3 Upload date Hashes View
Filename, size dataframe_image-0.0.6.tar.gz (12.7 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