Skip to main content

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

Project description

Automated Exploratory Data Analysis

Binder PyPI version Python 3.8 Python 3.7 | 3.9 Documentation Status

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. Graphical User Interface

Recommended. Use the command

eda_report

and select a file to analyse.

screencast of the gui

2. Command line interface

To analyse a file named input.csv:

eda_cli input.csv

Or even:

eda_cli 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_cli -h
usage: eda_cli [-h] [-o OUTFILE] [-t TITLE] [-c COLOR] 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 COLOR, --color COLOR
                        A valid matplotlib color specifier (default: orangered)

3. Interactive mode

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

where df is a pandas DataFrame.

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

eda_report-1.1.1.tar.gz (108.8 kB view hashes)

Uploaded Source

Built Distribution

eda_report-1.1.1-py3-none-any.whl (109.8 kB view hashes)

Uploaded Python 3

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