autooutlier 0.1.0__tar.gz

autooutlier-0.1.0/CHANGELOG.md

@@ -0,0 +1,135 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.1.0/),
+and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0.html).
+
+---
+
+## [0.1.0] - 2026-06-28
+
+### Added
+
+#### Core Features
+- Initial public release of **autooutlier**.
+- Automatic outlier detection with intelligent method selection.
+- Automatic outlier handling based on dataset characteristics.
+- Manual selection of detection and handling methods.
+- Support for custom replacement values.
+
+#### Statistics Module
+- Descriptive statistics:
+  - Mean
+  - Median
+  - Mode
+  - Standard Deviation
+  - Variance
+  - Data Range
+- Quartile calculations (Q1, Q3, IQR)
+- Skewness analysis
+- Kurtosis analysis
+- Distribution classification
+
+#### Detection Module
+Implemented the following outlier detection methods:
+
+- IQR Method
+- Z-Score Method
+- Modified Z-Score Method
+- Percentile Method
+- Automatic Detection Method Selection
+- Boolean Outlier Mask Generation
+
+#### Handling Module
+Implemented multiple outlier handling strategies:
+
+- Winsorization
+- Mean Replacement
+- Median Replacement
+- Mode Replacement
+- Interpolation
+- Forward Fill
+- Backward Fill
+- Custom Value Replacement
+- Outlier Removal
+- Automatic Handling Method Selection
+
+#### Summary Module
+Added comprehensive pre-cleaning analysis including:
+
+- Recommended detection method
+- Recommended handling method
+- Number of outliers
+- Percentage of outliers
+- Distribution type
+- Skewness report
+- Statistical summary
+
+#### Visualization Module
+- Box Plot visualization using Seaborn.
+
+#### Utility Module
+Added helper functions for:
+
+- Numeric column validation
+- Continuous data validation
+- Time-series detection
+- Outlier counting
+- Outlier percentage calculation
+
+#### Documentation
+Added professional project documentation including:
+
+- README
+- Installation Guide
+- User Guide
+- API Reference
+- Detection Methods Guide
+- Handling Methods Guide
+- Examples
+- FAQ
+- Changelog
+
+#### Examples
+Added practical usage examples demonstrating:
+
+- Automatic detection
+- Automatic handling
+- Manual detection
+- Manual handling
+- Summary generation
+
+#### Testing
+Added unit tests for:
+
+- Detection module
+- Handling module
+- Statistics module
+- Summary module
+
+#### Packaging
+Configured the project for distribution using:
+
+- pyproject.toml
+- setuptools
+- MANIFEST.in
+- Editable installation support
+- Source distribution (sdist)
+- Wheel distribution
+
+#### Project Structure
+Added:
+
+- MIT License
+- Version management
+- Documentation folder
+- Examples folder
+- Tests folder
+- Professional package layout
+
+---
+
+## License
+
+This project is licensed under the MIT License.

autooutlier-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 Suruthika C D
+
+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.

autooutlier-0.1.0/MANIFEST.in

@@ -0,0 +1,28 @@
+# ------------------------------------------------------------------
+# MANIFEST.in
+# Files to include in the source distribution (sdist)
+# ------------------------------------------------------------------
+
+# Project metadata
+include LICENSE
+include README.md
+include CHANGELOG.md
+include requirements.txt
+
+# Include all package source files
+recursive-include autooutlier *.py
+
+# Include documentation
+recursive-include docs *.md
+
+# Include examples
+recursive-include examples *.py
+
+# Include tests
+recursive-include tests *.py
+
+# Exclude Python cache files
+global-exclude *.py[cod]
+global-exclude __pycache__
+global-exclude *.so
+global-exclude .DS_Store

autooutlier-0.1.0/PKG-INFO

@@ -0,0 +1,202 @@
+Metadata-Version: 2.4
+Name: autooutlier
+Version: 0.1.0
+Summary: Automatic outlier detection and handling for Python.
+Author: Suruthika C D
+License: MIT
+Project-URL: Homepage, https://github.com/suruthika-cd/autooutlier
+Project-URL: Repository, https://github.com/suruthika-cd/autooutlier
+Project-URL: Documentation, https://github.com/suruthika-cd/autooutlier/tree/main/docs
+Project-URL: Issues, https://github.com/suruthika-cd/autooutlier/issues
+Project-URL: Changelog, https://github.com/suruthika-cd/autooutlier/blob/main/CHANGELOG.md
+Keywords: outlier,outlier-detection,statistics,data-cleaning,data-science,machine-learning,preprocessing,pandas
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: numpy>=1.21.0
+Requires-Dist: pandas>=1.3.0
+Requires-Dist: scipy>=1.7.0
+Requires-Dist: matplotlib>=3.4.0
+Requires-Dist: seaborn>=0.11.0
+Dynamic: license-file
+
+# autooutlier
+
+**Automatic Outlier Detection and Handling for Python**
+
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![PyPI version](https://img.shields.io/pypi/v/autooutlier.svg)](https://pypi.org/project/autooutlier/)
+
+---
+
+## Overview
+
+`autooutlier` is a Python package that **automatically detects, analyzes, and handles outliers** in numerical data. It intelligently selects the best detection and handling methods based on data distribution — requiring **zero configuration** from the user.
+
+Simply pass your DataFrame and column name, and `autooutlier` handles the rest.
+
+---
+
+## Features
+
+- **Automatic Detection** — Selects the optimal outlier detection method (Z-Score, Modified Z-Score, IQR, Percentile) based on data skewness.
+- **Automatic Handling** — Chooses the best outlier replacement strategy (winsorization, mean/median/mode replacement, interpolation, etc.) based on data characteristics.
+- **Statistical Analysis** — Provides mean, median, mode, standard deviation, variance, skewness, kurtosis, and distribution classification.
+- **Pre-Cleaning Summary** — Generates a comprehensive report before cleaning, including detection method, handling strategy, outlier count, and percentage.
+- **Post-Cleaning Report** — Returns both the cleaned dataset and an after-cleaning summary report.
+- **Flexible Manual Control** — Override automatic selections with manual detection and handling methods when needed.
+- **Visualization** — Built-in box plot support via Seaborn.
+
+---
+
+## Installation
+
+```bash
+pip install autooutlier
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/suruthika-cd/autooutlier.git
+cd autooutlier
+pip install -e .
+```
+
+### Dependencies
+
+- Python >= 3.8
+- NumPy >= 1.21.0
+- Pandas >= 1.3.0
+- SciPy >= 1.7.0
+- Seaborn >= 0.11.0
+- Matplotlib >= 3.4.0
+
+---
+
+## Quick Start
+
+```python
+import pandas as pd
+from autooutlier import handle_outliers, before_cleaning_summary, detect_outliers
+
+# Load your data
+df = pd.DataFrame({"values": [10, 12, 14, 11, 13, 100, 15, 12, 14, 11]})
+
+# Get a pre-cleaning summary report
+summary = before_cleaning_summary(df, "values")
+print(summary)
+
+# Automatically detect and handle outliers
+cleaned_data, report = handle_outliers(df, "values")
+print(report)
+print(cleaned_data)
+```
+
+---
+
+## Usage Examples
+
+### Automatic Outlier Detection
+
+```python
+from autooutlier import detect_outliers
+
+outlier_mask = detect_outliers(df, "column_name")
+print(f"Outliers found: {outlier_mask.sum()}")
+```
+
+### Automatic Outlier Handling
+
+```python
+from autooutlier import handle_outliers
+
+# Fully automatic — detection and handling methods are chosen for you
+cleaned_df, report = handle_outliers(df, "column_name")
+```
+
+### Manual Detection Method
+
+```python
+# Use a specific detection method
+cleaned_df, report = handle_outliers(df, "column_name", detection_method="z_score")
+```
+
+Available detection methods: `'auto'`, `'Iqr_method'`, `'z_score'`, `'modified_z_score'`, `'percentile'`
+
+### Manual Handling Method
+
+```python
+# Use a specific replacement strategy
+cleaned_df, report = handle_outliers(df, "column_name", replacement="median")
+```
+
+Available replacement methods: `'auto'`, `'interpolate'`, `'winsorization'`, `'median'`, `'mean'`, `'mode'`, `'custom'`, `'remove'`, `'bfill'`, `'ffill'`
+
+### Custom Value Replacement
+
+```python
+cleaned_df, report = handle_outliers(df, "column_name", replacement="custom", value=0)
+```
+
+### Pre-Cleaning Summary
+
+```python
+from autooutlier import before_cleaning_summary
+
+summary = before_cleaning_summary(df, "column_name")
+print(summary)
+```
+
+Output includes: suggested detection method, handling method, skewness, distribution type, outlier count, and outlier percentage.
+
+---
+
+## API Overview
+
+### Public API
+
+| Function | Description |
+|---|---|
+| `handle_outliers(data, column, detection_method='auto', replacement='auto', value=None)` | Detect and handle outliers. Returns `(cleaned_data, report)`. |
+| `detect_outliers(data, column)` | Detect outliers automatically. Returns a boolean mask. |
+| `detect_outlier_method(data, column)` | Returns the suggested detection method name. |
+| `before_cleaning_summary(data, column)` | Returns a DataFrame summary report before cleaning. |
+
+### Module Reference
+
+| Module | Contents |
+|---|---|
+| `autooutlier.statistics` | `mean`, `median`, `mode`, `std`, `var`, `data_range`, `q1`, `q3`, `iqr`, `skew`, `skew_measurment`, `is_normal`, `kurtosis`, `kurtosis_measurement` |
+| `autooutlier.detection` | `Iqr_method`, `z_score_method`, `modified_z_score`, `percentile_method`, `detect_outlier_method`, `detect_outliers` |
+| `autooutlier.handling` | `winsorization`, `interpolate`, `replace_with_mean`, `replace_with_median`, `replace_with_mode`, `replace_with_custom_value`, `replace_with_forward_fill`, `replace_with_backward_fill`, `remove_outliers`, `detect_handler`, `handle_outliers` |
+| `autooutlier.summary` | `before_cleaning_summary` |
+| `autooutlier.visualization` | `box_plot` |
+| `autooutlier.utils` | `is_numeric`, `is_time_series`, `is_continous`, `outlier_count`, `outlier_percentage` |
+
+---
+
+## License
+
+This project is licensed under the MIT License — see the [LICENSE](LICENSE) file for details.
+
+---
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for all notable changes.

autooutlier-0.1.0/README.md

@@ -0,0 +1,166 @@
+# autooutlier
+
+**Automatic Outlier Detection and Handling for Python**
+
+[![Python 3.8+](https://img.shields.io/badge/python-3.8+-blue.svg)](https://www.python.org/downloads/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![PyPI version](https://img.shields.io/pypi/v/autooutlier.svg)](https://pypi.org/project/autooutlier/)
+
+---
+
+## Overview
+
+`autooutlier` is a Python package that **automatically detects, analyzes, and handles outliers** in numerical data. It intelligently selects the best detection and handling methods based on data distribution — requiring **zero configuration** from the user.
+
+Simply pass your DataFrame and column name, and `autooutlier` handles the rest.
+
+---
+
+## Features
+
+- **Automatic Detection** — Selects the optimal outlier detection method (Z-Score, Modified Z-Score, IQR, Percentile) based on data skewness.
+- **Automatic Handling** — Chooses the best outlier replacement strategy (winsorization, mean/median/mode replacement, interpolation, etc.) based on data characteristics.
+- **Statistical Analysis** — Provides mean, median, mode, standard deviation, variance, skewness, kurtosis, and distribution classification.
+- **Pre-Cleaning Summary** — Generates a comprehensive report before cleaning, including detection method, handling strategy, outlier count, and percentage.
+- **Post-Cleaning Report** — Returns both the cleaned dataset and an after-cleaning summary report.
+- **Flexible Manual Control** — Override automatic selections with manual detection and handling methods when needed.
+- **Visualization** — Built-in box plot support via Seaborn.
+
+---
+
+## Installation
+
+```bash
+pip install autooutlier
+```
+
+Or install from source:
+
+```bash
+git clone https://github.com/suruthika-cd/autooutlier.git
+cd autooutlier
+pip install -e .
+```
+
+### Dependencies
+
+- Python >= 3.8
+- NumPy >= 1.21.0
+- Pandas >= 1.3.0
+- SciPy >= 1.7.0
+- Seaborn >= 0.11.0
+- Matplotlib >= 3.4.0
+
+---
+
+## Quick Start
+
+```python
+import pandas as pd
+from autooutlier import handle_outliers, before_cleaning_summary, detect_outliers
+
+# Load your data
+df = pd.DataFrame({"values": [10, 12, 14, 11, 13, 100, 15, 12, 14, 11]})
+
+# Get a pre-cleaning summary report
+summary = before_cleaning_summary(df, "values")
+print(summary)
+
+# Automatically detect and handle outliers
+cleaned_data, report = handle_outliers(df, "values")
+print(report)
+print(cleaned_data)
+```
+
+---
+
+## Usage Examples
+
+### Automatic Outlier Detection
+
+```python
+from autooutlier import detect_outliers
+
+outlier_mask = detect_outliers(df, "column_name")
+print(f"Outliers found: {outlier_mask.sum()}")
+```
+
+### Automatic Outlier Handling
+
+```python
+from autooutlier import handle_outliers
+
+# Fully automatic — detection and handling methods are chosen for you
+cleaned_df, report = handle_outliers(df, "column_name")
+```
+
+### Manual Detection Method
+
+```python
+# Use a specific detection method
+cleaned_df, report = handle_outliers(df, "column_name", detection_method="z_score")
+```
+
+Available detection methods: `'auto'`, `'Iqr_method'`, `'z_score'`, `'modified_z_score'`, `'percentile'`
+
+### Manual Handling Method
+
+```python
+# Use a specific replacement strategy
+cleaned_df, report = handle_outliers(df, "column_name", replacement="median")
+```
+
+Available replacement methods: `'auto'`, `'interpolate'`, `'winsorization'`, `'median'`, `'mean'`, `'mode'`, `'custom'`, `'remove'`, `'bfill'`, `'ffill'`
+
+### Custom Value Replacement
+
+```python
+cleaned_df, report = handle_outliers(df, "column_name", replacement="custom", value=0)
+```
+
+### Pre-Cleaning Summary
+
+```python
+from autooutlier import before_cleaning_summary
+
+summary = before_cleaning_summary(df, "column_name")
+print(summary)
+```
+
+Output includes: suggested detection method, handling method, skewness, distribution type, outlier count, and outlier percentage.
+
+---
+
+## API Overview
+
+### Public API
+
+| Function | Description |
+|---|---|
+| `handle_outliers(data, column, detection_method='auto', replacement='auto', value=None)` | Detect and handle outliers. Returns `(cleaned_data, report)`. |
+| `detect_outliers(data, column)` | Detect outliers automatically. Returns a boolean mask. |
+| `detect_outlier_method(data, column)` | Returns the suggested detection method name. |
+| `before_cleaning_summary(data, column)` | Returns a DataFrame summary report before cleaning. |
+
+### Module Reference
+
+| Module | Contents |
+|---|---|
+| `autooutlier.statistics` | `mean`, `median`, `mode`, `std`, `var`, `data_range`, `q1`, `q3`, `iqr`, `skew`, `skew_measurment`, `is_normal`, `kurtosis`, `kurtosis_measurement` |
+| `autooutlier.detection` | `Iqr_method`, `z_score_method`, `modified_z_score`, `percentile_method`, `detect_outlier_method`, `detect_outliers` |
+| `autooutlier.handling` | `winsorization`, `interpolate`, `replace_with_mean`, `replace_with_median`, `replace_with_mode`, `replace_with_custom_value`, `replace_with_forward_fill`, `replace_with_backward_fill`, `remove_outliers`, `detect_handler`, `handle_outliers` |
+| `autooutlier.summary` | `before_cleaning_summary` |
+| `autooutlier.visualization` | `box_plot` |
+| `autooutlier.utils` | `is_numeric`, `is_time_series`, `is_continous`, `outlier_count`, `outlier_percentage` |
+
+---
+
+## License
+
+This project is licensed under the MIT License — see the [LICENSE](LICENSE) file for details.
+
+---
+
+## Changelog
+
+See [CHANGELOG.md](CHANGELOG.md) for all notable changes.

autooutlier-0.1.0/autooutlier/__init__.py

@@ -0,0 +1,26 @@
+# -*- coding: utf-8 -*-
+"""
+autooutlier - Automatic Outlier Detection and Handling for Python
+=================================================================
+
+A professional Python package for automatic outlier detection,
+handling, and statistical analysis of numerical data.
+
+Usage:
+    >>> import autooutlier
+    >>> from autooutlier import handle_outliers, detect_outliers
+"""
+
+from .handling import handle_outliers
+from .summary import before_cleaning_summary
+from .detection import detect_outliers
+from .detection import detect_outlier_method
+from .version import __version__
+    
+__all__ = [
+    "handle_outliers",
+    "before_cleaning_summary",
+    "detect_outliers",
+    "detect_outlier_method",
+    "__version__",
+]

autooutlier-0.1.0/autooutlier/detection.py

@@ -0,0 +1,67 @@
+# -*- coding: utf-8 -*-
+"""Outlier detection methods."""
+
+import numpy as np
+
+from .statistics import mean, std, q1, q3, iqr, skew_measurment
+from .utils import is_numeric
+
+
+def Iqr_method(data,column):
+    q1_value=q1(data[column])
+    q3_value=q3(data[column])
+    IQR=iqr(data[column])
+    LowerFence=q1_value-1.5*IQR
+    upperFence=q3_value+1.5*IQR
+    outliers=(data[column]>upperFence) | (data[column]<LowerFence)
+    return outliers
+
+def z_score_method(data,column):
+    mean_value=mean(data[column])
+    std_value=std(data[column])
+    if std_value==0:
+        return np.zeros(len(data),dtype=bool)
+    z_score=(data[column]-mean_value)/std_value
+    outliers=abs(z_score)>3
+    return outliers
+
+def modified_z_score(data,column):
+    median_value=data[column].median()
+    absolute_value=abs(data[column]-median_value)
+    MAD=absolute_value.median()
+    if MAD==0:
+        return np.zeros(len(data),dtype=bool)
+    modified_z_score=0.6745*(data[column]-median_value)/MAD
+    outliers=abs(modified_z_score)>3.5
+    return outliers
+
+def percentile_method(data,column):
+    lower_limit=np.percentile(data[column],5)
+    upper_limit=np.percentile(data[column],95)
+    outliers=(data[column]>upper_limit) | (data[column]<lower_limit)
+    return outliers
+
+def detect_outlier_method(data,column):
+    numeric=is_numeric(data,column)
+    if not numeric :
+        return "It is not a numerical Column"
+    distribution=skew_measurment(data[column])
+    if distribution in ['Perfectly Symmetric','Approximately Symmetric']:
+        detection_method='z_score'
+    elif distribution in ['Highly Right Skewed','Highly Left Skewed','Moderately Right Skewed','Moderately Left Skewed']:
+        detection_method='modified_z_score'
+    else:
+        detection_method='Iqr_method'
+    return detection_method
+
+def detect_outliers(data,column):
+    method=detect_outlier_method(data,column)
+
+    if method == 'z_score':
+       return z_score_method(data,column)
+
+    elif method == 'modified_z_score':
+      return modified_z_score(data,column)
+
+    else:
+       return Iqr_method(data,column)