Metadata-Version: 2.1
Name: dataframe_image
Version: 0.0.6
Summary: Embed pandas DataFrames as images in pdf and markdown files when converting from Jupyter Notebooks
Home-page: https://github.com/dexplo/dataframe_image
Author: Ted Petrou
Author-email: petrou.theodore@gmail.com
License: MIT
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](https://raw.githubusercontent.com/dexplo/dataframe_image/master/images/dataframe_image_compare.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.
        
        ```python
        >>> 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.
        
        ```bash
        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`](https://github.com/dexplot/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
        
        * [pandas](https://github.com/pandas-dev/pandas)
        * [nbconvert](https://github.com/jupyter/nbconvert) which requires latex, xelatex, and pandoc
        * [pillow](https://github.com/python-pillow/Pillow)
        
        You must also have Google Chrome installed.
        
Keywords: jupyter notebook pandas dataframe image pdf markdown
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
