dscience-tools 1.0.0__tar.gz

dscience_tools-1.0.0/LICENSE

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

dscience_tools-1.0.0/MANIFEST.in

@@ -0,0 +1,4 @@
+include LICENSE
+include README.md
+prune issues
+prune results

dscience_tools-1.0.0/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.4
+Name: dscience_tools
+Version: 1.0.0
+Summary: DSTools: Data Science Tools Library
+Home-page: https://github.com/s-kav/ds_tools
+Author: Sergii Kavun
+Author-email: Sergii Kavun <kavserg@gmail.com>
+Maintainer-email: Sergii Kavun <kavserg@gmail.com>
+License: MIT License
+Project-URL: Homepage, https://github.com/s-kav/ds_tools
+Project-URL: Documentation, https://github.com/s-kav/ds_tools
+Project-URL: Repository, https://github.com/s-kav/ds_tools.git
+Project-URL: Source Code, https://github.com/s-kav/ds_tools/src
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.6.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas<=2.2.3,>=0.25.0
+Requires-Dist: numpy<=2.2.0,>=1.22.0
+Dynamic: license-file
+
+# DSTools: Data Science Tools Library
+
+[![PyPI version](https://badge.fury.io/py/dscience_tools.svg)](https://badge.fury.io/py/dscience_tools)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+# Authors
+
+- [@sergiikavun](https://www.linkedin.com/in/sergii-kavun/)
+
+**DSTools** is a Python library designed to assist data scientists and researchers by providing a collection of helpful functions for various stages of a data science project, from data exploration and preprocessing to model evaluation and synthetic data generation.
+
+# Table of Contents
+
+*   [Features](#features)
+*   [Installation](#installation)
+*   [Usage](#usage)
+*   [Function Overview](#function-overview)
+*   [Example](#example)
+*   [Contributing](#contributing)
+*   [References](#references)
+*   [License](#license)
+
+
+# Features
+
+- **Data Exploration:** Quickly get statistics for numerical and categorical features (`describe_numeric`, `describe_categorical`), check for missing values (`check_NINF`), and visualize correlations (`corr_matrix`).
+- **Model Evaluation:** Comprehensive classification model evaluation (`evaluate_classification`, `compute_metrics`) with clear visualizations (`plot_confusion_matrix`).
+- **Data Preprocessing:** Encode categorical variables (`labeling`), handle outliers (`remove_outliers_iqr`), and scale features (`min_max_scale`).
+- **Time Series Analysis:** Test for stationarity using the Dickey-Fuller test (`test_stationarity`).
+- **Synthetic Data Generation:** Create complex numerical distributions matching specific statistical moments (`generate_distribution`, `generate_distribution_from_metrics`).
+- **Advanced Statistics:** Calculate non-parametric correlation (`chatterjee_correlation`), entropy, and KL-divergence.
+- **Utilities:** Save/load DataFrames to/from ZIP archives, generate random alphanumeric codes, and more.
+
+
+# Installation
+
+## Clone the Repository
+
+```bash
+git clone https://github.com/s-kav/ds_tools.git
+
+```
+
+## Navigate to the Project Directory
+
+```bash
+cd ds_tools
+
+```
+
+## Install Dependencies
+
+Ensure you have Python version 3.8 or higher and install the required packages:
+
+```bash
+pip install -r requirements.txt
+
+```
+
+# Usage
+
+Here's a simple example of how to use the library to evaluate a classification model.
+
+
+```python
+
+import numpy as np
+from ds_tools import DSTools
+
+# 1. Initialize the toolkit
+tools = DSTools()
+
+# 2. Generate some dummy data
+y_true = np.array([0, 1, 1, 0, 1, 0, 0, 1])
+y_probs = np.array([0.1, 0.8, 0.6, 0.3, 0.9, 0.2, 0.4, 0.7])
+
+# 3. Get a comprehensive evaluation report
+# This will print metrics and show plots for ROC and Precision-Recall curves.
+results = tools.evaluate_classification(true_labels=y_true, pred_probs=y_probs)
+
+# The results are also returned as a dictionary
+print(f"\nROC AUC Score: {results['roc_auc']:.4f}")
+
+```
+
+
+Full code base for other function testing you can find [here](https://github.com/s-kav/ds_tools/blob/main/tests/code_checking_dstool.py).
+
+
+# Function Overview
+
+The library provides a wide range of functions. To see a full, formatted list of available tools, you can use the function_list method:
+
+```python
+
+from ds_tools import DSTools
+
+tools = DSTools()
+tools.function_list()
+
+```
+
+# Example
+
+Generating a Synthetic Distribution: need to create a dataset with specific statistical properties?
+generate_distribution_from_metrics can do that.
+
+
+```python
+
+from ds_tools import DSTools, DistributionConfig
+
+tools = DSTools()
+
+# Define the desired metrics
+metrics_config = DistributionConfig(
+    mean=1042,
+    median=330,
+    std=1500,
+    min_val=1,
+    max_val=120000,
+    skewness=13.2,
+    kurtosis=245, # Excess kurtosis
+    n=10000
+)
+
+# Generate the data
+generated_data = tools.generate_distribution_from_metrics(n=10000, metrics=metrics_config)
+
+print(f"Generated Mean: {np.mean(generated_data):.2f}")
+print(f"Generated Std: {np.std(generated_data):.2f}")
+
+```
+
+
+Full code base for other function testing you can find [here](https://github.com/s-kav/ds_tools/blob/main/tests/code_checking_dstool.py).
+
+
+# Contributing
+
+Contributions are welcome! Please feel free to submit a pull request or open an issue on the GitHub repository.
+
+To contribute:
+
+Fork the repository.
+Create a new branch for your feature or bugfix.
+Commit your changes with clear messages.
+Push to your fork and submit a pull request.
+Please ensure your code adheres to PEP8 standards and includes appropriate docstrings and comments.
+
+
+# References
+
+For citing you should use:
+
+Sergii Kavun. (2025). s-kav/ds_tools: Version 0.9.1 (v0.9.1). Zenodo. https://doi.org/10.5281/zenodo.15864146
+
+[![DOI](https://zenodo.org/badge/1001952407.svg)](https://doi.org/10.5281/zenodo.15864146)
+
+
+# License
+
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/s-kav/ds_tools/blob/main/LICENSE) file for details.

dscience_tools-1.0.0/README.md

@@ -0,0 +1,163 @@
+# DSTools: Data Science Tools Library
+
+[![PyPI version](https://badge.fury.io/py/dscience_tools.svg)](https://badge.fury.io/py/dscience_tools)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+# Authors
+
+- [@sergiikavun](https://www.linkedin.com/in/sergii-kavun/)
+
+**DSTools** is a Python library designed to assist data scientists and researchers by providing a collection of helpful functions for various stages of a data science project, from data exploration and preprocessing to model evaluation and synthetic data generation.
+
+# Table of Contents
+
+*   [Features](#features)
+*   [Installation](#installation)
+*   [Usage](#usage)
+*   [Function Overview](#function-overview)
+*   [Example](#example)
+*   [Contributing](#contributing)
+*   [References](#references)
+*   [License](#license)
+
+
+# Features
+
+- **Data Exploration:** Quickly get statistics for numerical and categorical features (`describe_numeric`, `describe_categorical`), check for missing values (`check_NINF`), and visualize correlations (`corr_matrix`).
+- **Model Evaluation:** Comprehensive classification model evaluation (`evaluate_classification`, `compute_metrics`) with clear visualizations (`plot_confusion_matrix`).
+- **Data Preprocessing:** Encode categorical variables (`labeling`), handle outliers (`remove_outliers_iqr`), and scale features (`min_max_scale`).
+- **Time Series Analysis:** Test for stationarity using the Dickey-Fuller test (`test_stationarity`).
+- **Synthetic Data Generation:** Create complex numerical distributions matching specific statistical moments (`generate_distribution`, `generate_distribution_from_metrics`).
+- **Advanced Statistics:** Calculate non-parametric correlation (`chatterjee_correlation`), entropy, and KL-divergence.
+- **Utilities:** Save/load DataFrames to/from ZIP archives, generate random alphanumeric codes, and more.
+
+
+# Installation
+
+## Clone the Repository
+
+```bash
+git clone https://github.com/s-kav/ds_tools.git
+
+```
+
+## Navigate to the Project Directory
+
+```bash
+cd ds_tools
+
+```
+
+## Install Dependencies
+
+Ensure you have Python version 3.8 or higher and install the required packages:
+
+```bash
+pip install -r requirements.txt
+
+```
+
+# Usage
+
+Here's a simple example of how to use the library to evaluate a classification model.
+
+
+```python
+
+import numpy as np
+from ds_tools import DSTools
+
+# 1. Initialize the toolkit
+tools = DSTools()
+
+# 2. Generate some dummy data
+y_true = np.array([0, 1, 1, 0, 1, 0, 0, 1])
+y_probs = np.array([0.1, 0.8, 0.6, 0.3, 0.9, 0.2, 0.4, 0.7])
+
+# 3. Get a comprehensive evaluation report
+# This will print metrics and show plots for ROC and Precision-Recall curves.
+results = tools.evaluate_classification(true_labels=y_true, pred_probs=y_probs)
+
+# The results are also returned as a dictionary
+print(f"\nROC AUC Score: {results['roc_auc']:.4f}")
+
+```
+
+
+Full code base for other function testing you can find [here](https://github.com/s-kav/ds_tools/blob/main/tests/code_checking_dstool.py).
+
+
+# Function Overview
+
+The library provides a wide range of functions. To see a full, formatted list of available tools, you can use the function_list method:
+
+```python
+
+from ds_tools import DSTools
+
+tools = DSTools()
+tools.function_list()
+
+```
+
+# Example
+
+Generating a Synthetic Distribution: need to create a dataset with specific statistical properties?
+generate_distribution_from_metrics can do that.
+
+
+```python
+
+from ds_tools import DSTools, DistributionConfig
+
+tools = DSTools()
+
+# Define the desired metrics
+metrics_config = DistributionConfig(
+    mean=1042,
+    median=330,
+    std=1500,
+    min_val=1,
+    max_val=120000,
+    skewness=13.2,
+    kurtosis=245, # Excess kurtosis
+    n=10000
+)
+
+# Generate the data
+generated_data = tools.generate_distribution_from_metrics(n=10000, metrics=metrics_config)
+
+print(f"Generated Mean: {np.mean(generated_data):.2f}")
+print(f"Generated Std: {np.std(generated_data):.2f}")
+
+```
+
+
+Full code base for other function testing you can find [here](https://github.com/s-kav/ds_tools/blob/main/tests/code_checking_dstool.py).
+
+
+# Contributing
+
+Contributions are welcome! Please feel free to submit a pull request or open an issue on the GitHub repository.
+
+To contribute:
+
+Fork the repository.
+Create a new branch for your feature or bugfix.
+Commit your changes with clear messages.
+Push to your fork and submit a pull request.
+Please ensure your code adheres to PEP8 standards and includes appropriate docstrings and comments.
+
+
+# References
+
+For citing you should use:
+
+Sergii Kavun. (2025). s-kav/ds_tools: Version 0.9.1 (v0.9.1). Zenodo. https://doi.org/10.5281/zenodo.15864146
+
+[![DOI](https://zenodo.org/badge/1001952407.svg)](https://doi.org/10.5281/zenodo.15864146)
+
+
+# License
+
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/s-kav/ds_tools/blob/main/LICENSE) file for details.

dscience_tools-1.0.0/pyproject.toml

@@ -0,0 +1,52 @@
+[project]
+name = "dscience_tools"
+version = "1.0.0"
+description = "DSTools: Data Science Tools Library"
+readme = "README.md"
+authors = [
+  { name="Sergii Kavun", email="kavserg@gmail.com" }
+]
+maintainers = [
+  { name="Sergii Kavun", email="kavserg@gmail.com" }
+]
+license = {text = "MIT License"}
+dependencies = ["pandas<=2.2.3,>=0.25.0", "numpy<=2.2.0,>=1.22.0"]
+requires-python = ">=3.6.0"
+classifiers = [
+    "Intended Audience :: Developers",
+    "Intended Audience :: Information Technology",
+    "Intended Audience :: Science/Research",
+    "Natural Language :: English",
+    "Operating System :: OS Independent",
+    "Programming Language :: Python",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.6",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Topic :: Scientific/Engineering :: Information Analysis",
+    "Topic :: Scientific/Engineering :: Mathematics",
+]
+
+dynamic = []
+
+[project.urls]
+Homepage = "https://github.com/s-kav/ds_tools"
+Documentation = "https://github.com/s-kav/ds_tools"
+Repository = "https://github.com/s-kav/ds_tools.git"
+"Source Code" = "https://github.com/s-kav/ds_tools/src"
+
+
+[build-system]
+requires = ["setuptools>=61", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.pytest.ini_options]
+addopts = [
+    "--import-mode=importlib",
+]
+filterwarnings = [
+    "ignore::pydantic.warnings.PydanticDeprecatedSince20",
+    "ignore::DeprecationWarning",
+    "error",
+]
+testpaths = ["tests"]

dscience_tools-1.0.0/setup.cfg

@@ -0,0 +1,46 @@
+[metadata]
+name = dscience_tools
+version = 0.9.1
+author = Sergii Kavun
+author_email = kavserg@gmail.com
+description = A library of helpful functions for various data science research stages.
+long_description = file: README.md
+long_description_content_type = text/markdown
+url = https://github.com/s-kav/ds_tools
+license = MIT
+classifiers = 
+	Programming Language :: Python :: 3
+	Programming Language :: Python :: 3.8
+	Programming Language :: Python :: 3.9
+	Programming Language :: Python :: 3.10
+	Programming Language :: Python :: 3.11
+	License :: OSI Approved :: MIT License
+	Operating System :: OS Independent
+	Intended Audience :: Developers
+	Intended Audience :: Science/Research
+	Topic :: Software Development :: Libraries :: Python Modules
+	Topic :: Scientific/Engineering
+
+[options]
+package_dir = 
+	= src
+packages = find:
+python_requires = >=3.8
+install_requires = 
+	numpy
+	pandas
+	polars
+	matplotlib
+	seaborn
+	scipy
+	scikit-learn
+	statsmodels
+	pydantic>=2.0
+
+[options.packages.find]
+where = src
+
+[egg_info]
+tag_build = 
+tag_date = 0
+

dscience_tools-1.0.0/src/dscience_tools.egg-info/PKG-INFO

@@ -0,0 +1,195 @@
+Metadata-Version: 2.4
+Name: dscience_tools
+Version: 1.0.0
+Summary: DSTools: Data Science Tools Library
+Home-page: https://github.com/s-kav/ds_tools
+Author: Sergii Kavun
+Author-email: Sergii Kavun <kavserg@gmail.com>
+Maintainer-email: Sergii Kavun <kavserg@gmail.com>
+License: MIT License
+Project-URL: Homepage, https://github.com/s-kav/ds_tools
+Project-URL: Documentation, https://github.com/s-kav/ds_tools
+Project-URL: Repository, https://github.com/s-kav/ds_tools.git
+Project-URL: Source Code, https://github.com/s-kav/ds_tools/src
+Classifier: Intended Audience :: Developers
+Classifier: Intended Audience :: Information Technology
+Classifier: Intended Audience :: Science/Research
+Classifier: Natural Language :: English
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.6
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Topic :: Scientific/Engineering :: Information Analysis
+Classifier: Topic :: Scientific/Engineering :: Mathematics
+Requires-Python: >=3.6.0
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pandas<=2.2.3,>=0.25.0
+Requires-Dist: numpy<=2.2.0,>=1.22.0
+Dynamic: license-file
+
+# DSTools: Data Science Tools Library
+
+[![PyPI version](https://badge.fury.io/py/dscience_tools.svg)](https://badge.fury.io/py/dscience_tools)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+# Authors
+
+- [@sergiikavun](https://www.linkedin.com/in/sergii-kavun/)
+
+**DSTools** is a Python library designed to assist data scientists and researchers by providing a collection of helpful functions for various stages of a data science project, from data exploration and preprocessing to model evaluation and synthetic data generation.
+
+# Table of Contents
+
+*   [Features](#features)
+*   [Installation](#installation)
+*   [Usage](#usage)
+*   [Function Overview](#function-overview)
+*   [Example](#example)
+*   [Contributing](#contributing)
+*   [References](#references)
+*   [License](#license)
+
+
+# Features
+
+- **Data Exploration:** Quickly get statistics for numerical and categorical features (`describe_numeric`, `describe_categorical`), check for missing values (`check_NINF`), and visualize correlations (`corr_matrix`).
+- **Model Evaluation:** Comprehensive classification model evaluation (`evaluate_classification`, `compute_metrics`) with clear visualizations (`plot_confusion_matrix`).
+- **Data Preprocessing:** Encode categorical variables (`labeling`), handle outliers (`remove_outliers_iqr`), and scale features (`min_max_scale`).
+- **Time Series Analysis:** Test for stationarity using the Dickey-Fuller test (`test_stationarity`).
+- **Synthetic Data Generation:** Create complex numerical distributions matching specific statistical moments (`generate_distribution`, `generate_distribution_from_metrics`).
+- **Advanced Statistics:** Calculate non-parametric correlation (`chatterjee_correlation`), entropy, and KL-divergence.
+- **Utilities:** Save/load DataFrames to/from ZIP archives, generate random alphanumeric codes, and more.
+
+
+# Installation
+
+## Clone the Repository
+
+```bash
+git clone https://github.com/s-kav/ds_tools.git
+
+```
+
+## Navigate to the Project Directory
+
+```bash
+cd ds_tools
+
+```
+
+## Install Dependencies
+
+Ensure you have Python version 3.8 or higher and install the required packages:
+
+```bash
+pip install -r requirements.txt
+
+```
+
+# Usage
+
+Here's a simple example of how to use the library to evaluate a classification model.
+
+
+```python
+
+import numpy as np
+from ds_tools import DSTools
+
+# 1. Initialize the toolkit
+tools = DSTools()
+
+# 2. Generate some dummy data
+y_true = np.array([0, 1, 1, 0, 1, 0, 0, 1])
+y_probs = np.array([0.1, 0.8, 0.6, 0.3, 0.9, 0.2, 0.4, 0.7])
+
+# 3. Get a comprehensive evaluation report
+# This will print metrics and show plots for ROC and Precision-Recall curves.
+results = tools.evaluate_classification(true_labels=y_true, pred_probs=y_probs)
+
+# The results are also returned as a dictionary
+print(f"\nROC AUC Score: {results['roc_auc']:.4f}")
+
+```
+
+
+Full code base for other function testing you can find [here](https://github.com/s-kav/ds_tools/blob/main/tests/code_checking_dstool.py).
+
+
+# Function Overview
+
+The library provides a wide range of functions. To see a full, formatted list of available tools, you can use the function_list method:
+
+```python
+
+from ds_tools import DSTools
+
+tools = DSTools()
+tools.function_list()
+
+```
+
+# Example
+
+Generating a Synthetic Distribution: need to create a dataset with specific statistical properties?
+generate_distribution_from_metrics can do that.
+
+
+```python
+
+from ds_tools import DSTools, DistributionConfig
+
+tools = DSTools()
+
+# Define the desired metrics
+metrics_config = DistributionConfig(
+    mean=1042,
+    median=330,
+    std=1500,
+    min_val=1,
+    max_val=120000,
+    skewness=13.2,
+    kurtosis=245, # Excess kurtosis
+    n=10000
+)
+
+# Generate the data
+generated_data = tools.generate_distribution_from_metrics(n=10000, metrics=metrics_config)
+
+print(f"Generated Mean: {np.mean(generated_data):.2f}")
+print(f"Generated Std: {np.std(generated_data):.2f}")
+
+```
+
+
+Full code base for other function testing you can find [here](https://github.com/s-kav/ds_tools/blob/main/tests/code_checking_dstool.py).
+
+
+# Contributing
+
+Contributions are welcome! Please feel free to submit a pull request or open an issue on the GitHub repository.
+
+To contribute:
+
+Fork the repository.
+Create a new branch for your feature or bugfix.
+Commit your changes with clear messages.
+Push to your fork and submit a pull request.
+Please ensure your code adheres to PEP8 standards and includes appropriate docstrings and comments.
+
+
+# References
+
+For citing you should use:
+
+Sergii Kavun. (2025). s-kav/ds_tools: Version 0.9.1 (v0.9.1). Zenodo. https://doi.org/10.5281/zenodo.15864146
+
+[![DOI](https://zenodo.org/badge/1001952407.svg)](https://doi.org/10.5281/zenodo.15864146)
+
+
+# License
+
+This project is licensed under the MIT License - see the [LICENSE](https://github.com/s-kav/ds_tools/blob/main/LICENSE) file for details.