quicksea 0.1.0__tar.gz

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
quicksea-0.1.0/LICENSE ADDED
@@ -0,0 +1,21 @@
1
+ MIT License
2
+
3
+ Copyright (c) 2026 Lennox
4
+
5
+ Permission is hereby granted, free of charge, to any person obtaining a copy
6
+ of this software and associated documentation files (the "Software"), to deal
7
+ in the Software without restriction, including without limitation the rights
8
+ to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
9
+ copies of the Software, and to permit persons to whom the Software is
10
+ furnished to do so, subject to the following conditions:
11
+
12
+ The above copyright notice and this permission notice shall be included in all
13
+ copies or substantial portions of the Software.
14
+
15
+ THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
16
+ IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
17
+ FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
18
+ AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
19
+ LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
20
+ OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
21
+ SOFTWARE.
@@ -0,0 +1,120 @@
1
+ Metadata-Version: 2.1
2
+ Name: quicksea
3
+ Version: 0.1.0
4
+ Summary: Fast and intuitive 2D/3D interactive visualizations and exploratory data analysis using Plotly.
5
+ Home-page: https://github.com/lennox/quicksea
6
+ Author: Lennox
7
+ Author-email: lennox@example.com
8
+ License: MIT
9
+ Platform: UNKNOWN
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: Intended Audience :: Science/Research
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.8
15
+ Classifier: Programming Language :: Python :: 3.9
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: License :: OSI Approved :: MIT License
20
+ Classifier: Operating System :: OS Independent
21
+ Classifier: Topic :: Scientific/Engineering :: Visualization
22
+ Requires-Python: >=3.8
23
+ Description-Content-Type: text/markdown
24
+ Provides-Extra: jupyter
25
+ License-File: LICENSE
26
+
27
+ # quicksea 🌊
28
+
29
+ [![PyPI version](https://img.shields.io/pypi/v/quicksea.svg)](https://pypi.org/project/quicksea/)
30
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
31
+
32
+ **quicksea** is a lightweight Python library for fast, interactive 2D and 3D exploratory data visualization powered by Plotly.
33
+
34
+ ---
35
+
36
+ ## Features
37
+
38
+ - **2D Multi-Pair Scatter Plots**: Batch-plot multiple feature pairs in interactive Plotly figures with a single line of code.
39
+ - **3D Feature Exploration**: Generate interactive 3D scatter plots across triplets of features with color encoding.
40
+ - **EDA Utilities**: Quick data profiling for missing values and summary statistics.
41
+ - **Jupyter & Script Compatible**: Works out-of-the-box in Jupyter Notebooks, Google Colab, and standard Python scripts.
42
+
43
+ ---
44
+
45
+ ## Installation
46
+
47
+ Install `quicksea` from PyPI:
48
+
49
+ ```bash
50
+ pip install quicksea
51
+ ```
52
+
53
+ To include Jupyter notebook dependencies:
54
+
55
+ ```bash
56
+ pip install "quicksea[jupyter]"
57
+ ```
58
+
59
+ ---
60
+
61
+ ## Quickstart
62
+
63
+ ```python
64
+ import pandas as pd
65
+ from quicksea import Visualizer
66
+
67
+ # Sample data
68
+ df = pd.DataFrame({
69
+ "age": [22, 38, 26, 35, 54],
70
+ "fare": [7.25, 71.28, 7.92, 53.10, 51.86],
71
+ "pclass": [3, 1, 3, 1, 1],
72
+ "survived": [0, 1, 1, 1, 0]
73
+ })
74
+
75
+ # Initialize visualizer with a color column (e.g. classification target)
76
+ viz = Visualizer(color_column="survived")
77
+
78
+ # 1. Quick EDA: missing values and descriptive statistics
79
+ viz.check_nan_describe(df)
80
+
81
+ # 2. 2D Scatter plots
82
+ pairs = [("age", "fare"), ("pclass", "fare")]
83
+ viz.scatter_2d(df, pairs)
84
+
85
+ # 3. 3D Scatter plot
86
+ triplets = [("age", "fare", "pclass")]
87
+ viz.scatter_3d(df, triplets)
88
+ ```
89
+
90
+ ---
91
+
92
+ ## API Reference
93
+
94
+ ### `Visualizer(color_column=None)`
95
+ - **`color_column`** *(str, optional)*: DataFrame column name used to group/color markers.
96
+
97
+ ### Methods
98
+
99
+ #### `scatter_2d(X, two_d_plot_cols, show=True)`
100
+ - **`X`** *(pd.DataFrame)*: Input dataset.
101
+ - **`two_d_plot_cols`** *(list of (str, str))*: List of `(x_column, y_column)` tuples.
102
+ - **`show`** *(bool, default=True)*: Whether to display each figure with `fig.show()`.
103
+ - **Returns**: `List[plotly.graph_objects.Figure]`
104
+
105
+ #### `scatter_3d(X, three_d_plot_cols, show=True)`
106
+ - **`X`** *(pd.DataFrame)*: Input dataset.
107
+ - **`three_d_plot_cols`** *(list of (str, str, str))*: List of `(x_column, y_column, z_column)` tuples.
108
+ - **`show`** *(bool, default=True)*: Whether to display each figure with `fig.show()`.
109
+ - **Returns**: `List[plotly.graph_objects.Figure]`
110
+
111
+ #### `check_nan_describe(df)`
112
+ - **`df`** *(pd.DataFrame)*: Displays NaN count and descriptive summary.
113
+
114
+ ---
115
+
116
+ ## License
117
+
118
+ MIT License. See [LICENSE](LICENSE) for details.
119
+
120
+
@@ -0,0 +1,92 @@
1
+ # quicksea 🌊
2
+
3
+ [![PyPI version](https://img.shields.io/pypi/v/quicksea.svg)](https://pypi.org/project/quicksea/)
4
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
5
+
6
+ **quicksea** is a lightweight Python library for fast, interactive 2D and 3D exploratory data visualization powered by Plotly.
7
+
8
+ ---
9
+
10
+ ## Features
11
+
12
+ - **2D Multi-Pair Scatter Plots**: Batch-plot multiple feature pairs in interactive Plotly figures with a single line of code.
13
+ - **3D Feature Exploration**: Generate interactive 3D scatter plots across triplets of features with color encoding.
14
+ - **EDA Utilities**: Quick data profiling for missing values and summary statistics.
15
+ - **Jupyter & Script Compatible**: Works out-of-the-box in Jupyter Notebooks, Google Colab, and standard Python scripts.
16
+
17
+ ---
18
+
19
+ ## Installation
20
+
21
+ Install `quicksea` from PyPI:
22
+
23
+ ```bash
24
+ pip install quicksea
25
+ ```
26
+
27
+ To include Jupyter notebook dependencies:
28
+
29
+ ```bash
30
+ pip install "quicksea[jupyter]"
31
+ ```
32
+
33
+ ---
34
+
35
+ ## Quickstart
36
+
37
+ ```python
38
+ import pandas as pd
39
+ from quicksea import Visualizer
40
+
41
+ # Sample data
42
+ df = pd.DataFrame({
43
+ "age": [22, 38, 26, 35, 54],
44
+ "fare": [7.25, 71.28, 7.92, 53.10, 51.86],
45
+ "pclass": [3, 1, 3, 1, 1],
46
+ "survived": [0, 1, 1, 1, 0]
47
+ })
48
+
49
+ # Initialize visualizer with a color column (e.g. classification target)
50
+ viz = Visualizer(color_column="survived")
51
+
52
+ # 1. Quick EDA: missing values and descriptive statistics
53
+ viz.check_nan_describe(df)
54
+
55
+ # 2. 2D Scatter plots
56
+ pairs = [("age", "fare"), ("pclass", "fare")]
57
+ viz.scatter_2d(df, pairs)
58
+
59
+ # 3. 3D Scatter plot
60
+ triplets = [("age", "fare", "pclass")]
61
+ viz.scatter_3d(df, triplets)
62
+ ```
63
+
64
+ ---
65
+
66
+ ## API Reference
67
+
68
+ ### `Visualizer(color_column=None)`
69
+ - **`color_column`** *(str, optional)*: DataFrame column name used to group/color markers.
70
+
71
+ ### Methods
72
+
73
+ #### `scatter_2d(X, two_d_plot_cols, show=True)`
74
+ - **`X`** *(pd.DataFrame)*: Input dataset.
75
+ - **`two_d_plot_cols`** *(list of (str, str))*: List of `(x_column, y_column)` tuples.
76
+ - **`show`** *(bool, default=True)*: Whether to display each figure with `fig.show()`.
77
+ - **Returns**: `List[plotly.graph_objects.Figure]`
78
+
79
+ #### `scatter_3d(X, three_d_plot_cols, show=True)`
80
+ - **`X`** *(pd.DataFrame)*: Input dataset.
81
+ - **`three_d_plot_cols`** *(list of (str, str, str))*: List of `(x_column, y_column, z_column)` tuples.
82
+ - **`show`** *(bool, default=True)*: Whether to display each figure with `fig.show()`.
83
+ - **Returns**: `List[plotly.graph_objects.Figure]`
84
+
85
+ #### `check_nan_describe(df)`
86
+ - **`df`** *(pd.DataFrame)*: Displays NaN count and descriptive summary.
87
+
88
+ ---
89
+
90
+ ## License
91
+
92
+ MIT License. See [LICENSE](LICENSE) for details.
@@ -0,0 +1,40 @@
1
+ [build-system]
2
+ requires = ["setuptools>=61.0", "wheel"]
3
+ build-backend = "setuptools.build_meta"
4
+
5
+ [project]
6
+ name = "quicksea"
7
+ version = "0.1.0"
8
+ description = "Fast and intuitive 2D/3D interactive visualizations and exploratory data analysis using Plotly."
9
+ readme = "README.md"
10
+ authors = [
11
+ { name = "Lennox", email = "lennox@example.com" }
12
+ ]
13
+ license = { text = "MIT" }
14
+ classifiers = [
15
+ "Development Status :: 3 - Alpha",
16
+ "Intended Audience :: Developers",
17
+ "Intended Audience :: Science/Research",
18
+ "Programming Language :: Python :: 3",
19
+ "Programming Language :: Python :: 3.8",
20
+ "Programming Language :: Python :: 3.9",
21
+ "Programming Language :: Python :: 3.10",
22
+ "Programming Language :: Python :: 3.11",
23
+ "Programming Language :: Python :: 3.12",
24
+ "License :: OSI Approved :: MIT License",
25
+ "Operating System :: OS Independent",
26
+ "Topic :: Scientific/Engineering :: Visualization",
27
+ ]
28
+ keywords = ["visualization", "plotly", "eda", "data-science", "scatter-plot", "interactive"]
29
+ requires-python = ">=3.8"
30
+ dependencies = [
31
+ "plotly>=5.0.0",
32
+ "pandas>=1.0.0",
33
+ ]
34
+
35
+ [project.optional-dependencies]
36
+ jupyter = ["ipython>=7.0.0"]
37
+
38
+ [project.urls]
39
+ "Homepage" = "https://github.com/lennox/quicksea"
40
+ "Bug Tracker" = "https://github.com/lennox/quicksea/issues"
@@ -0,0 +1,4 @@
1
+ [egg_info]
2
+ tag_build =
3
+ tag_date = 0
4
+
@@ -0,0 +1,41 @@
1
+ from setuptools import setup, find_packages
2
+ from pathlib import Path
3
+
4
+ this_directory = Path(__file__).parent
5
+ long_description = (this_directory / "README.md").read_text(encoding="utf-8")
6
+
7
+ setup(
8
+ name="quicksea",
9
+ version="0.1.0",
10
+ description="Fast and intuitive 2D/3D interactive visualizations and exploratory data analysis using Plotly.",
11
+ long_description=long_description,
12
+ long_description_content_type="text/markdown",
13
+ author="Lennox",
14
+ author_email="lennox@example.com",
15
+ url="https://github.com/lennox/quicksea",
16
+ license="MIT",
17
+ package_dir={"": "src"},
18
+ packages=find_packages(where="src"),
19
+ install_requires=[
20
+ "plotly>=5.0.0",
21
+ "pandas>=1.0.0",
22
+ ],
23
+ extras_require={
24
+ "jupyter": ["ipython>=7.0.0"],
25
+ },
26
+ classifiers=[
27
+ "Development Status :: 3 - Alpha",
28
+ "Intended Audience :: Developers",
29
+ "Intended Audience :: Science/Research",
30
+ "Programming Language :: Python :: 3",
31
+ "Programming Language :: Python :: 3.8",
32
+ "Programming Language :: Python :: 3.9",
33
+ "Programming Language :: Python :: 3.10",
34
+ "Programming Language :: Python :: 3.11",
35
+ "Programming Language :: Python :: 3.12",
36
+ "License :: OSI Approved :: MIT License",
37
+ "Operating System :: OS Independent",
38
+ "Topic :: Scientific/Engineering :: Visualization",
39
+ ],
40
+ python_requires=">=3.8",
41
+ )
@@ -0,0 +1,8 @@
1
+ """
2
+ quicksea: Fast and intuitive 2D/3D visualizations and EDA utilities powered by Plotly.
3
+ """
4
+
5
+ from .visuals import Visualizer
6
+
7
+ __version__ = "0.1.0"
8
+ __all__ = ["Visualizer"]
@@ -0,0 +1,117 @@
1
+ """
2
+ Core visualization and EDA module for quicksea.
3
+ """
4
+
5
+ from typing import List, Tuple, Optional, Any
6
+ import plotly.express as px
7
+ import plotly.graph_objects as go
8
+ import pandas as pd
9
+
10
+ try:
11
+ from IPython.display import display
12
+ except ImportError:
13
+ display = print
14
+
15
+
16
+ class Visualizer:
17
+ """
18
+ Utility class for fast 2D and 3D interactive plotting and EDA using Plotly.
19
+ """
20
+
21
+ def __init__(self, color_column: Optional[str] = None):
22
+ """
23
+ Initialize the Visualizer.
24
+
25
+ Parameters
26
+ ----------
27
+ color_column : str, optional
28
+ The column name in the DataFrame to use for color-coding points.
29
+ """
30
+ self.color_column = color_column
31
+
32
+ def scatter_2d(
33
+ self,
34
+ X: pd.DataFrame,
35
+ two_d_plot_cols: List[Tuple[str, str]],
36
+ show: bool = True,
37
+ ) -> List[go.Figure]:
38
+ """
39
+ Create 2D scatter plots for pairs of features.
40
+
41
+ Parameters
42
+ ----------
43
+ X : pd.DataFrame
44
+ The input DataFrame containing the features.
45
+ two_d_plot_cols : list of tuple of (str, str)
46
+ List of (x_col, y_col) pairs to plot against each other.
47
+ show : bool, default True
48
+ Whether to immediately display the figures using fig.show().
49
+
50
+ Returns
51
+ -------
52
+ list of plotly.graph_objects.Figure
53
+ The generated Plotly figures.
54
+ """
55
+ figures = []
56
+ for x_axis_data, y_axis_data in two_d_plot_cols:
57
+ fig = px.scatter(
58
+ X,
59
+ x=x_axis_data,
60
+ y=y_axis_data,
61
+ color=self.color_column,
62
+ title=f"{y_axis_data} vs {x_axis_data}",
63
+ )
64
+ if show:
65
+ fig.show()
66
+ figures.append(fig)
67
+ return figures
68
+
69
+ def scatter_3d(
70
+ self,
71
+ X: pd.DataFrame,
72
+ three_d_plot_cols: List[Tuple[str, str, str]],
73
+ show: bool = True,
74
+ ) -> List[go.Figure]:
75
+ """
76
+ Create 3D scatter plots for triplets of features.
77
+
78
+ Parameters
79
+ ----------
80
+ X : pd.DataFrame
81
+ The input DataFrame containing the features.
82
+ three_d_plot_cols : list of tuple of (str, str, str)
83
+ List of (x_col, y_col, z_col) triplets to plot against each other.
84
+ show : bool, default True
85
+ Whether to immediately display the figures using fig.show().
86
+
87
+ Returns
88
+ -------
89
+ list of plotly.graph_objects.Figure
90
+ The generated Plotly figures.
91
+ """
92
+ figures = []
93
+ for x_axis_data, y_axis_data, z_axis_data in three_d_plot_cols:
94
+ fig = px.scatter_3d(
95
+ X,
96
+ x=x_axis_data,
97
+ y=y_axis_data,
98
+ z=z_axis_data,
99
+ color=self.color_column,
100
+ title=f"{z_axis_data} vs {y_axis_data} vs {x_axis_data}",
101
+ )
102
+ if show:
103
+ fig.show()
104
+ figures.append(fig)
105
+ return figures
106
+
107
+ def check_nan_describe(self, df: pd.DataFrame) -> None:
108
+ """
109
+ Display NaN counts and descriptive statistics for a DataFrame.
110
+
111
+ Parameters
112
+ ----------
113
+ df : pd.DataFrame
114
+ The DataFrame to inspect.
115
+ """
116
+ display(df.isna().sum())
117
+ display(df.describe())
@@ -0,0 +1,120 @@
1
+ Metadata-Version: 2.1
2
+ Name: quicksea
3
+ Version: 0.1.0
4
+ Summary: Fast and intuitive 2D/3D interactive visualizations and exploratory data analysis using Plotly.
5
+ Home-page: https://github.com/lennox/quicksea
6
+ Author: Lennox
7
+ Author-email: lennox@example.com
8
+ License: MIT
9
+ Platform: UNKNOWN
10
+ Classifier: Development Status :: 3 - Alpha
11
+ Classifier: Intended Audience :: Developers
12
+ Classifier: Intended Audience :: Science/Research
13
+ Classifier: Programming Language :: Python :: 3
14
+ Classifier: Programming Language :: Python :: 3.8
15
+ Classifier: Programming Language :: Python :: 3.9
16
+ Classifier: Programming Language :: Python :: 3.10
17
+ Classifier: Programming Language :: Python :: 3.11
18
+ Classifier: Programming Language :: Python :: 3.12
19
+ Classifier: License :: OSI Approved :: MIT License
20
+ Classifier: Operating System :: OS Independent
21
+ Classifier: Topic :: Scientific/Engineering :: Visualization
22
+ Requires-Python: >=3.8
23
+ Description-Content-Type: text/markdown
24
+ Provides-Extra: jupyter
25
+ License-File: LICENSE
26
+
27
+ # quicksea 🌊
28
+
29
+ [![PyPI version](https://img.shields.io/pypi/v/quicksea.svg)](https://pypi.org/project/quicksea/)
30
+ [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
31
+
32
+ **quicksea** is a lightweight Python library for fast, interactive 2D and 3D exploratory data visualization powered by Plotly.
33
+
34
+ ---
35
+
36
+ ## Features
37
+
38
+ - **2D Multi-Pair Scatter Plots**: Batch-plot multiple feature pairs in interactive Plotly figures with a single line of code.
39
+ - **3D Feature Exploration**: Generate interactive 3D scatter plots across triplets of features with color encoding.
40
+ - **EDA Utilities**: Quick data profiling for missing values and summary statistics.
41
+ - **Jupyter & Script Compatible**: Works out-of-the-box in Jupyter Notebooks, Google Colab, and standard Python scripts.
42
+
43
+ ---
44
+
45
+ ## Installation
46
+
47
+ Install `quicksea` from PyPI:
48
+
49
+ ```bash
50
+ pip install quicksea
51
+ ```
52
+
53
+ To include Jupyter notebook dependencies:
54
+
55
+ ```bash
56
+ pip install "quicksea[jupyter]"
57
+ ```
58
+
59
+ ---
60
+
61
+ ## Quickstart
62
+
63
+ ```python
64
+ import pandas as pd
65
+ from quicksea import Visualizer
66
+
67
+ # Sample data
68
+ df = pd.DataFrame({
69
+ "age": [22, 38, 26, 35, 54],
70
+ "fare": [7.25, 71.28, 7.92, 53.10, 51.86],
71
+ "pclass": [3, 1, 3, 1, 1],
72
+ "survived": [0, 1, 1, 1, 0]
73
+ })
74
+
75
+ # Initialize visualizer with a color column (e.g. classification target)
76
+ viz = Visualizer(color_column="survived")
77
+
78
+ # 1. Quick EDA: missing values and descriptive statistics
79
+ viz.check_nan_describe(df)
80
+
81
+ # 2. 2D Scatter plots
82
+ pairs = [("age", "fare"), ("pclass", "fare")]
83
+ viz.scatter_2d(df, pairs)
84
+
85
+ # 3. 3D Scatter plot
86
+ triplets = [("age", "fare", "pclass")]
87
+ viz.scatter_3d(df, triplets)
88
+ ```
89
+
90
+ ---
91
+
92
+ ## API Reference
93
+
94
+ ### `Visualizer(color_column=None)`
95
+ - **`color_column`** *(str, optional)*: DataFrame column name used to group/color markers.
96
+
97
+ ### Methods
98
+
99
+ #### `scatter_2d(X, two_d_plot_cols, show=True)`
100
+ - **`X`** *(pd.DataFrame)*: Input dataset.
101
+ - **`two_d_plot_cols`** *(list of (str, str))*: List of `(x_column, y_column)` tuples.
102
+ - **`show`** *(bool, default=True)*: Whether to display each figure with `fig.show()`.
103
+ - **Returns**: `List[plotly.graph_objects.Figure]`
104
+
105
+ #### `scatter_3d(X, three_d_plot_cols, show=True)`
106
+ - **`X`** *(pd.DataFrame)*: Input dataset.
107
+ - **`three_d_plot_cols`** *(list of (str, str, str))*: List of `(x_column, y_column, z_column)` tuples.
108
+ - **`show`** *(bool, default=True)*: Whether to display each figure with `fig.show()`.
109
+ - **Returns**: `List[plotly.graph_objects.Figure]`
110
+
111
+ #### `check_nan_describe(df)`
112
+ - **`df`** *(pd.DataFrame)*: Displays NaN count and descriptive summary.
113
+
114
+ ---
115
+
116
+ ## License
117
+
118
+ MIT License. See [LICENSE](LICENSE) for details.
119
+
120
+
@@ -0,0 +1,11 @@
1
+ LICENSE
2
+ README.md
3
+ pyproject.toml
4
+ setup.py
5
+ src/quicksea/__init__.py
6
+ src/quicksea/visuals.py
7
+ src/quicksea.egg-info/PKG-INFO
8
+ src/quicksea.egg-info/SOURCES.txt
9
+ src/quicksea.egg-info/dependency_links.txt
10
+ src/quicksea.egg-info/requires.txt
11
+ src/quicksea.egg-info/top_level.txt
@@ -0,0 +1,5 @@
1
+ plotly>=5.0.0
2
+ pandas>=1.0.0
3
+
4
+ [jupyter]
5
+ ipython>=7.0.0
@@ -0,0 +1 @@
1
+ quicksea