dora-eda 3.0.1__tar.gz

dora_eda-3.0.1/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 Asif Sayyed
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

dora_eda-3.0.1/PKG-INFO

@@ -0,0 +1,166 @@
+Metadata-Version: 2.4
+Name: dora-eda
+Version: 3.0.1
+Summary: Exploratory data analysis and presentation tool
+License: MIT
+License-File: LICENSE
+Author: Asif Sayyed
+Author-email: asifdotexe@gmail.com
+Requires-Python: >=3.13
+Classifier: Programming Language :: Python :: 3
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Requires-Dist: jinja2 (>=3.1.6,<4.0.0)
+Requires-Dist: matplotlib (>=3.10.6,<4.0.0)
+Requires-Dist: numpy (>=2.3.3,<3.0.0)
+Requires-Dist: openpyxl (>=3.1.5,<4.0.0)
+Requires-Dist: pandas (>=2.3.3,<3.0.0)
+Requires-Dist: pyarrow (>=21.0.0,<22.0.0)
+Requires-Dist: pyyaml (>=6.0.3,<7.0.0)
+Requires-Dist: seaborn (>=0.13.2,<0.14.0)
+Requires-Dist: tqdm (>=4.67.1,<5.0.0)
+Requires-Dist: typer[rich] (>=0.19.2,<0.20.0)
+Project-URL: Repository, https://github.com/Asifdotexe/DORA
+Description-Content-Type: text/markdown
+
+# Data Oriented Report Automator (DORA)
+
+<p align="center">
+    <img src="data/assets/dora-updated-concept.png" alt="DORA Logo" width="200"/>
+</p>
+
+<em align="center">
+An interactive command-line tool to automate Exploratory Data Analysis (EDA) and generate beautiful, insightful reports in seconds.
+</em>
+
+## Overview
+
+Welcome to DORA! This isn't just a script; it's an intelligent EDA assistant. DORA empowers you to move from a raw dataset to a comprehensive HTML report with minimal effort. It is designed to be powerful and configurable for experts, yet simple enough for anyone to use thanks to its interactive wizard.
+
+
+## 1. installation
+Install DORA directly from PyPI using pip:
+```bash
+pip install dora-eda
+# check version to validate installation
+dora -v
+```
+
+## 2. Usage
+DORA has two modes of operation: Interactive (for first-time runs) and Config-Driven (for reproducible automation).
+Run DORA without existing configuration (Fresh run)
+
+## A. Interactive Mode (Quick Start)
+Simply run the command without arguments. DORA will launch a wizard to guide you through the setup.
+
+```bash
+dora
+```
+You will be prompted to:
+- Select your data file (CSV, Excel, JSON, Parquet).
+- Choose an output directory.
+- (Optional) Select a target variable for focused analysis.
+- Pick which analysis steps to perform.
+- (Optional) Save your settings to a `config.yaml` file for future use.
+
+## B. Config-Driven Mode (Advanced)
+If you already have a configuration file (e.g., from a previous run), you can skip the wizard and run the analysis immediately.
+
+```bash
+dora --config <path/to/config.yaml>
+```
+
+**Example `config.yaml`:**
+```bash
+# --- Input/Output Settings ---
+input_file: 'data/insurance.csv'
+output_dir: 'output/insurance_report'
+report_title: 'Exploratory Data Analysis of Insurance Premiums'
+
+# --- Dataset Settings ---
+target_variable: 'charges'
+
+# --- Analysis Pipeline ---
+analysis_pipeline:
+  - profile:
+      enabled: true
+  - univariate:
+      enabled: true
+      plot_types:
+        numerical: ['histogram', 'boxplot']
+        categorical: ['barplot']
+  - bivariate:
+      enabled: true
+      target_centric: true
+  - multivariate:
+      enabled: true
+      correlation_cols: ['age', 'bmi', 'children', 'charges']
+```
+## 3. Supported Data Formats
+DORA automatically detects and reads the following file types:
+- CSV (`*.csv`)
+- Excel (`*.xlsx`) - Note: Analyzes the first sheet only.
+- JSON (`*.json`)
+- Parquet (`*.parquet`)
+
+## 4. Viewing the Output
+After the analysis is complete, check your output directory for:
+- 📄 `eda_report.html`: The full, interactive report. Open this in any web browser.
+- 📈 `charts/`: A folder containing all generated plots as high-quality images.
+
+# Developer Guide
+Interested in contributing to DORA? Awesome! Follow these steps to set up your local development environment.
+
+## 1. Prerequisites
+You need Poetry for dependency management.
+```bash
+# Windows (Powershell)
+(Invoke-WebRequest -Uri [https://install.python-poetry.org](https://install.python-poetry.org) -UseBasicParsing).Content | py -
+
+# Linux/macOS
+curl -sSL [https://install.python-poetry.org](https://install.python-poetry.org) | python3 -
+```
+
+## 2. Setup
+Clone the repository and install dependencies (including dev tools).
+```bash
+git clone https://github.com/Asifdotexe/DORA.git
+cd dora
+poetry install --with dev
+```
+
+## 3. Code Quality
+We use standard tools to keep the codebase clean. Please run these before submitting a PR.
+
+**Automated Checks (Recommended):**
+Install the pre-commit hooks once, and they will run automatically on every commit.
+```bash
+poetry run pre-commit install
+```
+**Manual Checks:**
+```bash
+# Format code
+poetry run black .
+poetry run isort .
+
+# Lint code
+poetry run pylint src/dora
+```
+**Running Tests:**
+```bash
+poetry run pytest
+```
+
+## 4. How to Contribute
+1. Fork the repository.
+2. Create a feature branch (`git checkout -b feature/amazing-feature`).
+3. Commit your changes.
+4. Push to the branch.
+5. Open a Pull Request.
+
+## License
+This project is licensed under the MIT License. See the `LICENSE` file for details.
+
+Happy analyzing with DORA! 🎉
+

dora_eda-3.0.1/README.md

@@ -0,0 +1,139 @@
+# Data Oriented Report Automator (DORA)
+
+<p align="center">
+    <img src="data/assets/dora-updated-concept.png" alt="DORA Logo" width="200"/>
+</p>
+
+<em align="center">
+An interactive command-line tool to automate Exploratory Data Analysis (EDA) and generate beautiful, insightful reports in seconds.
+</em>
+
+## Overview
+
+Welcome to DORA! This isn't just a script; it's an intelligent EDA assistant. DORA empowers you to move from a raw dataset to a comprehensive HTML report with minimal effort. It is designed to be powerful and configurable for experts, yet simple enough for anyone to use thanks to its interactive wizard.
+
+
+## 1. installation
+Install DORA directly from PyPI using pip:
+```bash
+pip install dora-eda
+# check version to validate installation
+dora -v
+```
+
+## 2. Usage
+DORA has two modes of operation: Interactive (for first-time runs) and Config-Driven (for reproducible automation).
+Run DORA without existing configuration (Fresh run)
+
+## A. Interactive Mode (Quick Start)
+Simply run the command without arguments. DORA will launch a wizard to guide you through the setup.
+
+```bash
+dora
+```
+You will be prompted to:
+- Select your data file (CSV, Excel, JSON, Parquet).
+- Choose an output directory.
+- (Optional) Select a target variable for focused analysis.
+- Pick which analysis steps to perform.
+- (Optional) Save your settings to a `config.yaml` file for future use.
+
+## B. Config-Driven Mode (Advanced)
+If you already have a configuration file (e.g., from a previous run), you can skip the wizard and run the analysis immediately.
+
+```bash
+dora --config <path/to/config.yaml>
+```
+
+**Example `config.yaml`:**
+```bash
+# --- Input/Output Settings ---
+input_file: 'data/insurance.csv'
+output_dir: 'output/insurance_report'
+report_title: 'Exploratory Data Analysis of Insurance Premiums'
+
+# --- Dataset Settings ---
+target_variable: 'charges'
+
+# --- Analysis Pipeline ---
+analysis_pipeline:
+  - profile:
+      enabled: true
+  - univariate:
+      enabled: true
+      plot_types:
+        numerical: ['histogram', 'boxplot']
+        categorical: ['barplot']
+  - bivariate:
+      enabled: true
+      target_centric: true
+  - multivariate:
+      enabled: true
+      correlation_cols: ['age', 'bmi', 'children', 'charges']
+```
+## 3. Supported Data Formats
+DORA automatically detects and reads the following file types:
+- CSV (`*.csv`)
+- Excel (`*.xlsx`) - Note: Analyzes the first sheet only.
+- JSON (`*.json`)
+- Parquet (`*.parquet`)
+
+## 4. Viewing the Output
+After the analysis is complete, check your output directory for:
+- 📄 `eda_report.html`: The full, interactive report. Open this in any web browser.
+- 📈 `charts/`: A folder containing all generated plots as high-quality images.
+
+# Developer Guide
+Interested in contributing to DORA? Awesome! Follow these steps to set up your local development environment.
+
+## 1. Prerequisites
+You need Poetry for dependency management.
+```bash
+# Windows (Powershell)
+(Invoke-WebRequest -Uri [https://install.python-poetry.org](https://install.python-poetry.org) -UseBasicParsing).Content | py -
+
+# Linux/macOS
+curl -sSL [https://install.python-poetry.org](https://install.python-poetry.org) | python3 -
+```
+
+## 2. Setup
+Clone the repository and install dependencies (including dev tools).
+```bash
+git clone https://github.com/Asifdotexe/DORA.git
+cd dora
+poetry install --with dev
+```
+
+## 3. Code Quality
+We use standard tools to keep the codebase clean. Please run these before submitting a PR.
+
+**Automated Checks (Recommended):**
+Install the pre-commit hooks once, and they will run automatically on every commit.
+```bash
+poetry run pre-commit install
+```
+**Manual Checks:**
+```bash
+# Format code
+poetry run black .
+poetry run isort .
+
+# Lint code
+poetry run pylint src/dora
+```
+**Running Tests:**
+```bash
+poetry run pytest
+```
+
+## 4. How to Contribute
+1. Fork the repository.
+2. Create a feature branch (`git checkout -b feature/amazing-feature`).
+3. Commit your changes.
+4. Push to the branch.
+5. Open a Pull Request.
+
+## License
+This project is licensed under the MIT License. See the `LICENSE` file for details.
+
+Happy analyzing with DORA! 🎉

dora_eda-3.0.1/pyproject.toml

@@ -0,0 +1,59 @@
+[project]
+name = "dora-eda"
+version = "3.0.1"
+description = "Exploratory data analysis and presentation tool"
+authors = [
+    {name = "Asif Sayyed",email = "asifdotexe@gmail.com"}
+]
+license = {text = "MIT"}
+readme = "README.md"
+requires-python = ">=3.13"
+dependencies = [
+    "pandas (>=2.3.3,<3.0.0)",
+    "seaborn (>=0.13.2,<0.14.0)",
+    "numpy (>=2.3.3,<3.0.0)",
+    "matplotlib (>=3.10.6,<4.0.0)",
+    "tqdm (>=4.67.1,<5.0.0)",
+    "typer[rich] (>=0.19.2,<0.20.0)",
+    "pyyaml (>=6.0.3,<7.0.0)",
+    "jinja2 (>=3.1.6,<4.0.0)",
+    "openpyxl (>=3.1.5,<4.0.0)",
+    "pyarrow (>=21.0.0,<22.0.0)"
+]
+
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+]
+
+urls = {Repository = "https://github.com/Asifdotexe/DORA"}
+
+[tool.poetry]
+package-mode = true
+packages = [{ include = "dora", from = "src" }]
+
+[tool.poetry.scripts]
+dora = "dora.main:main"
+
+[tool.poetry.group.dev.dependencies]
+pylint = "^3.3.9"
+black = "^25.9.0"
+isort = "^6.1.0"
+pre-commit = "^4.3.0"
+ipykernel = "^6.30.1"
+pytest = "^8.4.2"
+pytest-benchmark = "^5.1.0"
+snakeviz = "^2.2.2"
+
+[tool.pylint.format]
+max-line-length = 120
+
+[tool.pylint.messages_control]
+disable = ["redefined-outer-name", "invalid-name", "assignment-from-no-return", "too-many-branches",
+           "unused-argument", "unnecessary-pass", "fixme", "too-few-public-methods"]
+
+[build-system]
+requires = ["poetry-core>=2.0.0,<3.0.0"]
+build-backend = "poetry.core.masonry.api"

dora_eda-3.0.1/src/dora/__init__.py

@@ -0,0 +1 @@
+

dora_eda-3.0.1/src/dora/analyzer.py

@@ -0,0 +1,99 @@
+"""
+This module will orchestrate the analysis
+"""
+
+import logging
+import os
+
+import pandas as pd
+
+from .plots import bivariate, multivariate, univariate
+from .profiling import generate_profile
+from .reporting.generator import create_report
+
+
+class Analyzer:
+    """
+    Orchestrates the entire Exploratory data analysis process based on configuration.
+    """
+
+    def __init__(self, df: pd.DataFrame, config: dict):
+        self.df = df
+        self.config = config
+        self.output_dir = self.config["output_dir"]
+        self.charts_dir = os.path.join(self.output_dir, "charts")
+        self.report_data = {"title": self.config.get("report_title", "EDA Report")}
+
+        # To keep our project tidy, we'll create dedicated folders for our outputs right away.
+        # This prevents clutter and makes the final report easy to find.
+        os.makedirs(self.charts_dir, exist_ok=True)
+
+    def run(self):
+        """
+        Executes the analysis pipeline defined in the config.
+        This is the main conductor, stepping through the user's chosen analysis
+        plan and running each part in order.
+        """
+        pipeline = self.config.get("analysis_pipeline", [])
+
+        for step in pipeline:
+            step_name = list(step.keys())[0]
+            params = step[step_name]
+
+            # We only run the steps that the user has explicitly enabled in the config.
+            # This makes the tool flexible and respects the user's choices.
+            if params and params.get("enabled", False):
+                logging.info("--- Running Step: %s ---", step_name.capitalize())
+                if step_name == "profile":
+                    self._run_profiling()
+                elif step_name == "univariate":
+                    self._run_univariate(params)
+                elif step_name == "bivariate":
+                    self._run_bivariate(params)
+                elif step_name == "multivariate":
+                    self._run_multivariate(params)
+
+        # After all the analysis is done, we compile everything into a
+        # beautiful, easy-to-read report.
+        self._generate_report()
+
+    def _run_profiling(self):
+        # This step gives us a quick summary of the dataset's health and structure.
+        profile_results = generate_profile(self.df)
+        self.report_data["profile"] = profile_results
+
+    def _run_univariate(self, params: dict):
+        # By looking at columns one by one, we can understand their individual characteristics.
+        univariate_plots = univariate.generate_plots(self.df, self.charts_dir, params)
+        self.report_data["univariate_plots"] = univariate_plots
+
+    def _run_bivariate(self, params: dict):
+        # Now we start looking for connections. If the user has a specific goal (a target variable),
+        # this is where we explore how other features might influence it.
+        target = self.config.get("target_variable")
+
+        # It's important to check if a target was actually provided.
+        # Running this analysis without one wouldn't make sense, so we'll skip it.
+        if params.get("target_centric") and not target:
+            logging.warning(
+                "Bivariate 'target_centric' is true, but no 'target_variable' is defined. Skipping."
+            )
+            return
+
+        bivariate_plots = bivariate.generate_plots(
+            self.df, target, self.charts_dir, params
+        )
+        self.report_data["bivariate_plots"] = bivariate_plots
+
+    def _run_multivariate(self, params: dict):
+        # This is where we see how numerical features interact with each other.
+        # The correlation matrix is a powerful tool to spot these broader relationships at a glance.
+        multivariate_plots = multivariate.generate_plots(
+            self.df, self.charts_dir, params
+        )
+        self.report_data["multivariate_plots"] = multivariate_plots
+
+    def _generate_report(self):
+        # We take all the charts and insights we've gathered and collate them into a single HTML report.
+        logging.info("--- Generating HTML Report ---")
+        create_report(self.report_data, self.output_dir)

dora_eda-3.0.1/src/dora/config_loader.py

@@ -0,0 +1,27 @@
+"""
+This module helps to load and validate the configuration file
+"""
+
+import logging
+from pathlib import Path
+
+import yaml
+
+
+def load_config(config_path: Path) -> dict:
+    """
+    Load and validate the YAML configuration file
+
+    :param config_path: Path to the YAML configuration file
+    :returns: A dictionary containing the configurations
+    """
+    logging.info("Reading the configuration file from %s", config_path)
+    with open(config_path, "r", encoding="utf-8") as file:
+        config = yaml.safe_load(file) or {}
+
+    # validation
+    if "input_file" not in config or "output_dir" not in config:
+        raise ValueError("Config file must contain 'input_file' and 'output_dir'.")
+
+    logging.info("Configuration loaded successfully")
+    return config