quicksea 0.1.0__py3-none-any.whl

quicksea/__init__.py

@@ -0,0 +1,8 @@
+"""
+quicksea: Fast and intuitive 2D/3D visualizations and EDA utilities powered by Plotly.
+"""
+
+from .visuals import Visualizer
+
+__version__ = "0.1.0"
+__all__ = ["Visualizer"]

quicksea/visuals.py

@@ -0,0 +1,117 @@
+"""
+Core visualization and EDA module for quicksea.
+"""
+
+from typing import List, Tuple, Optional, Any
+import plotly.express as px
+import plotly.graph_objects as go
+import pandas as pd
+
+try:
+    from IPython.display import display
+except ImportError:
+    display = print
+
+
+class Visualizer:
+    """
+    Utility class for fast 2D and 3D interactive plotting and EDA using Plotly.
+    """
+
+    def __init__(self, color_column: Optional[str] = None):
+        """
+        Initialize the Visualizer.
+
+        Parameters
+        ----------
+        color_column : str, optional
+            The column name in the DataFrame to use for color-coding points.
+        """
+        self.color_column = color_column
+
+    def scatter_2d(
+        self,
+        X: pd.DataFrame,
+        two_d_plot_cols: List[Tuple[str, str]],
+        show: bool = True,
+    ) -> List[go.Figure]:
+        """
+        Create 2D scatter plots for pairs of features.
+
+        Parameters
+        ----------
+        X : pd.DataFrame
+            The input DataFrame containing the features.
+        two_d_plot_cols : list of tuple of (str, str)
+            List of (x_col, y_col) pairs to plot against each other.
+        show : bool, default True
+            Whether to immediately display the figures using fig.show().
+
+        Returns
+        -------
+        list of plotly.graph_objects.Figure
+            The generated Plotly figures.
+        """
+        figures = []
+        for x_axis_data, y_axis_data in two_d_plot_cols:
+            fig = px.scatter(
+                X,
+                x=x_axis_data,
+                y=y_axis_data,
+                color=self.color_column,
+                title=f"{y_axis_data} vs {x_axis_data}",
+            )
+            if show:
+                fig.show()
+            figures.append(fig)
+        return figures
+
+    def scatter_3d(
+        self,
+        X: pd.DataFrame,
+        three_d_plot_cols: List[Tuple[str, str, str]],
+        show: bool = True,
+    ) -> List[go.Figure]:
+        """
+        Create 3D scatter plots for triplets of features.
+
+        Parameters
+        ----------
+        X : pd.DataFrame
+            The input DataFrame containing the features.
+        three_d_plot_cols : list of tuple of (str, str, str)
+            List of (x_col, y_col, z_col) triplets to plot against each other.
+        show : bool, default True
+            Whether to immediately display the figures using fig.show().
+
+        Returns
+        -------
+        list of plotly.graph_objects.Figure
+            The generated Plotly figures.
+        """
+        figures = []
+        for x_axis_data, y_axis_data, z_axis_data in three_d_plot_cols:
+            fig = px.scatter_3d(
+                X,
+                x=x_axis_data,
+                y=y_axis_data,
+                z=z_axis_data,
+                color=self.color_column,
+                title=f"{z_axis_data} vs {y_axis_data} vs {x_axis_data}",
+            )
+            if show:
+                fig.show()
+            figures.append(fig)
+        return figures
+
+    def check_nan_describe(self, df: pd.DataFrame) -> None:
+        """
+        Display NaN counts and descriptive statistics for a DataFrame.
+
+        Parameters
+        ----------
+        df : pd.DataFrame
+            The DataFrame to inspect.
+        """
+        display(df.isna().sum())
+        display(df.describe())

quicksea-0.1.0.dist-info/LICENSE

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

quicksea-0.1.0.dist-info/METADATA

@@ -0,0 +1,123 @@
+Metadata-Version: 2.1
+Name: quicksea
+Version: 0.1.0
+Summary: Fast and intuitive 2D/3D interactive visualizations and exploratory data analysis using Plotly.
+Home-page: https://github.com/lennox/quicksea
+Author: Lennox
+Author-email: lennox@example.com
+License: MIT
+Platform: UNKNOWN
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Science/Research
+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: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Scientific/Engineering :: Visualization
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: plotly>=5.0.0
+Requires-Dist: pandas>=1.0.0
+Provides-Extra: jupyter
+Requires-Dist: ipython>=7.0.0; extra == "jupyter"
+
+# quicksea 🌊
+
+[![PyPI version](https://img.shields.io/pypi/v/quicksea.svg)](https://pypi.org/project/quicksea/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+**quicksea** is a lightweight Python library for fast, interactive 2D and 3D exploratory data visualization powered by Plotly.
+
+---
+
+## Features
+
+- **2D Multi-Pair Scatter Plots**: Batch-plot multiple feature pairs in interactive Plotly figures with a single line of code.
+- **3D Feature Exploration**: Generate interactive 3D scatter plots across triplets of features with color encoding.
+- **EDA Utilities**: Quick data profiling for missing values and summary statistics.
+- **Jupyter & Script Compatible**: Works out-of-the-box in Jupyter Notebooks, Google Colab, and standard Python scripts.
+
+---
+
+## Installation
+
+Install `quicksea` from PyPI:
+
+```bash
+pip install quicksea
+```
+
+To include Jupyter notebook dependencies:
+
+```bash
+pip install "quicksea[jupyter]"
+```
+
+---
+
+## Quickstart
+
+```python
+import pandas as pd
+from quicksea import Visualizer
+
+# Sample data
+df = pd.DataFrame({
+    "age": [22, 38, 26, 35, 54],
+    "fare": [7.25, 71.28, 7.92, 53.10, 51.86],
+    "pclass": [3, 1, 3, 1, 1],
+    "survived": [0, 1, 1, 1, 0]
+})
+
+# Initialize visualizer with a color column (e.g. classification target)
+viz = Visualizer(color_column="survived")
+
+# 1. Quick EDA: missing values and descriptive statistics
+viz.check_nan_describe(df)
+
+# 2. 2D Scatter plots
+pairs = [("age", "fare"), ("pclass", "fare")]
+viz.scatter_2d(df, pairs)
+
+# 3. 3D Scatter plot
+triplets = [("age", "fare", "pclass")]
+viz.scatter_3d(df, triplets)
+```
+
+---
+
+## API Reference
+
+### `Visualizer(color_column=None)`
+- **`color_column`** *(str, optional)*: DataFrame column name used to group/color markers.
+
+### Methods
+
+#### `scatter_2d(X, two_d_plot_cols, show=True)`
+- **`X`** *(pd.DataFrame)*: Input dataset.
+- **`two_d_plot_cols`** *(list of (str, str))*: List of `(x_column, y_column)` tuples.
+- **`show`** *(bool, default=True)*: Whether to display each figure with `fig.show()`.
+- **Returns**: `List[plotly.graph_objects.Figure]`
+
+#### `scatter_3d(X, three_d_plot_cols, show=True)`
+- **`X`** *(pd.DataFrame)*: Input dataset.
+- **`three_d_plot_cols`** *(list of (str, str, str))*: List of `(x_column, y_column, z_column)` tuples.
+- **`show`** *(bool, default=True)*: Whether to display each figure with `fig.show()`.
+- **Returns**: `List[plotly.graph_objects.Figure]`
+
+#### `check_nan_describe(df)`
+- **`df`** *(pd.DataFrame)*: Displays NaN count and descriptive summary.
+
+---
+
+## License
+
+MIT License. See [LICENSE](LICENSE) for details.
+
+

quicksea-0.1.0.dist-info/RECORD

@@ -0,0 +1,7 @@
+quicksea/__init__.py,sha256=XhYvI1u-GWpjMNhx3ak_lx_WXEgS3ifi32FmRJ1QB0Y,176
+quicksea/visuals.py,sha256=IdJQr0Z3j4x8QxIyU7AlDvBeEsh_MV71li3O-O1i3B0,3345
+quicksea-0.1.0.dist-info/LICENSE,sha256=Reo-kKVSu9-mBOHM2MPoxbr60wGyT-F4ak7ADPXvI0k,1063
+quicksea-0.1.0.dist-info/METADATA,sha256=KR0GtafZN8ZpOiQ9C15EqFLF2RuLAm3M0J20al6Neiw,3740
+quicksea-0.1.0.dist-info/WHEEL,sha256=EWGgdj_eH-g9dwsWZOTG0kmGucEuKPxGzOKD-jAVUHs,92
+quicksea-0.1.0.dist-info/top_level.txt,sha256=6-m_Hq-AmSlruGvXV8u2CLt5Qh0htwRCfvApsVo7fII,9
+quicksea-0.1.0.dist-info/RECORD,,

quicksea-0.1.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: bdist_wheel (0.48.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

quicksea-0.1.0.dist-info/top_level.txt

@@ -0,0 +1 @@
+quicksea