pysuricata 0.0.6

A lightweight EDA tool inspired by the curious nature of suricates. Built just for fun 🔬.

pysuricata

A lightweight Python library to generate self-contained HTML reports for exploratory data analysis (EDA).

📖 Read the documentation

Installation

Install pysuricata directly from PyPI:

pip install pysuricata

Why use pysuricata?

• Instant reports: Generate clean, self-contained HTML reports directly from pandas DataFrames.
• No dependencies on heavy frameworks: Only requires pandas and numpy.
• Rich insights: Summaries for numeric, categorical, datetime columns, missing values, duplicates, correlations, and sample rows.
• Portable: Reports are standalone HTML (with inline CSS/JS/images) that can be easily shared.
• Customizable: Title, sample display, and output path can be tailored to your needs.

Quick Example

The following example demonstrates how to generate an EDA report using the Iris dataset with Pandas:

import pandas as pd
import pysuricata
from IPython.display import HTML

# Load the Iris dataset directly using Pandas
iris_url = "https://raw.githubusercontent.com/mwaskom/seaborn-data/master/iris.csv"
iris_df = pd.read_csv(iris_url)

# Generate the HTML EDA report and save it to a file
html_report = pysuricata.generate_report(iris_df, output_file="iris_report.html")

# Display the report in a Jupyter Notebook
HTML(html_report)