eda-report 0.0.5

A simple program to get a basic EDA report in .docx format.

Automated Exploratory Data Analysis

A simple Python program to help automate EDA report generation.

The data is analysed using pandas' built in methods, and graphs are plotted using matplotlib & seaborn. The results are then packaged as a Word .docx file using python-docx.

Installation

You can install the package from PyPI using:

pip install eda-report

Basic usage

1. Command line interface

To analyse a file named input.csv:

eda_report input.csv

Or even:

eda_report input.csv -o output.docx -c cyan --title 'EDA Report'

For more details on the optional arguments, pass the -h or --help flag to view the help message:

$ eda_report -h
usage: eda_report [-h] [-o OUTFILE] [-t TITLE] [-c COLOUR] infile

Get a basic EDA report in docx format.

positional arguments:
  infile                A .csv or .xlsx file to process.

optional arguments:
  -h, --help            show this help message and exit
  -o OUTFILE, --outfile OUTFILE
                        The output file (default: eda-report.docx)
  -t TITLE, --title TITLE
                        The top level heading in the report (default: Exploratory Data Analysis Report)
  -c COLOUR, --colour COLOUR
                        A valid matplotlib color specifier (default: orangered)

2. Interactive mode

>>> from eda_report import get_word_report
>>> get_word_report(df)

where df is a pandas DataFrame.