A simple program to get a basic EDA report in .docx format.
Project description
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
.
Project details
Release history Release notifications | RSS feed
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-0.0.4.tar.gz
(8.9 kB
view hashes)
Built Distribution
eda_report-0.0.4-py3-none-any.whl
(11.0 kB
view hashes)
Close
Hashes for eda_report-0.0.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9fb420d5a04cb5e498f13a02c689bc6bcb02dcc2f5bbd7c12ad04523db5728c9 |
|
MD5 | 2be2f260c74c66a9d8554b27415ad2c4 |
|
BLAKE2b-256 | 8084bbfc99e79bd30fd756b259e8135daa72f2df377c68477705d682b96806bc |