PyPI - stouputils - Versions diffs - 1.4.7__tar.gz → 1.4.8__tar.gz - Mend

stouputils 1.4.7tar.gz → 1.4.8tar.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.

Files changed (107) hide show

{stouputils-1.4.7 → stouputils-1.4.8}/LICENSE RENAMED Viewed

@@ -1,21 +1,21 @@
-MIT License
-Copyright (c) 2024 Alexandre Collignon
-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.
+MIT License
+Copyright (c) 2024 Alexandre Collignon
+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.

{stouputils-1.4.7 → stouputils-1.4.8}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stouputils
-Version: 1.4.7
+Version: 1.4.8
 Summary: Stouputils is a collection of utility modules designed to simplify and enhance the development process. It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers, and many more.
 Project-URL: Homepage, https://github.com/Stoupy51/stouputils
 Project-URL: Issues, https://github.com/Stoupy51/stouputils/issues

{stouputils-1.4.7 → stouputils-1.4.8}/README.md RENAMED Viewed

@@ -1,102 +1,102 @@
-# 🛠️ Project Badges
-[![GitHub](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=github&label=GitHub)](https://github.com/Stoupy51/stouputils/releases/latest)
-[![PyPI - Downloads](https://img.shields.io/pypi/dm/stouputils?logo=python&label=PyPI%20downloads)](https://pypi.org/project/stouputils/)
-[![Documentation](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=sphinx&label=Documentation&color=purple)](https://stoupy51.github.io/stouputils/latest/)
-<br>
-# 📚 Project Overview
-Stouputils is a collection of utility modules designed to simplify and enhance the development process.<br>
-It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers.
-# 🚀 Project File Tree
-<html>
-<details style="display: none;">
-<summary></summary>
-<style>
-.code-tree {
-	border-radius: 6px;
-	padding: 16px;
-	font-family: monospace;
-	line-height: 1.45;
-	overflow: auto;
-	white-space: pre;
-	background-color:rgb(43, 43, 43);
-	color: #d4d4d4;
-}
-.code-tree a {
-	color: #569cd6;
-	text-decoration: none;
-}
-.code-tree a:hover {
-	text-decoration: underline;
-}
-.code-tree .comment {
-	color:rgb(231, 213, 48);
-}
-</style>
-</details>
-<pre class="code-tree">stouputils/
-├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.html">applications/</a>
-│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.automatic_docs.html">automatic_docs.py</a>    <span class="comment"># 📚 Documentation generation utilities (used to create this documentation)</span>
-│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.upscaler.html">upscaler/</a>            <span class="comment"># 🔎 Image & Video upscaler (configurable)</span>
-│   └── ...
-│
-├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.html">continuous_delivery/</a>
-│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.cd_utils.html">cd_utils.py</a>          <span class="comment"># 🔧 Common utilities for continuous delivery</span>
-│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.github.html">github.py</a>            <span class="comment"># 📦 GitHub utilities (upload_to_github)</span>
-│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.pypi.html">pypi.py</a>              <span class="comment"># 📦 PyPI utilities (pypi_full_routine)</span>
-│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.pyproject.html">pyproject.py</a>         <span class="comment"># 📝 Pyproject.toml utilities</span>
-│   └── ...
-│
-├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.html">data_science/</a>
-│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.config.html">config/</a>              <span class="comment"># ⚙️ Configuration utilities for data science</span>
-│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.dataset.html">dataset/</a>             <span class="comment"># 📊 Dataset handling (dataset, dataset_loader, grouping_strategy)</span>
-│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.data_processing.html">data_processing/</a>     <span class="comment"># 🔄 Data processing utilities (image augmentation, preprocessing)</span>
-│   │   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.data_processing.image.html">image/</a>           <span class="comment"># 🖼️ Image processing techniques</span>
-│   │   └── ...
-│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.html">models/</a>              <span class="comment"># 🧠 ML/DL model interfaces and implementations</span>
-│   │   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.keras.html">keras/</a>           <span class="comment"># 🤖 Keras model implementations</span>
-│   │   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.keras_utils.html">keras_utils/</a>     <span class="comment"># 🛠️ Keras utilities (callbacks, losses, visualizations)</span>
-│   │   └── ...
-│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.scripts.html">scripts/</a>             <span class="comment"># 📜 Data science scripts (augment, preprocess, routine)</span>
-│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.metric_utils.html">metric_utils.py</a>      <span class="comment"># 📏 Metrics utilities for ML/DL models</span>
-│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.mlflow_utils.html">mlflow_utils.py</a>      <span class="comment"># 📊 MLflow integration utilities</span>
-│   └── ...
-│
-├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.html">installer/</a>
-│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.common.html">common.py</a>            <span class="comment"># 🔧 Common installer utilities</span>
-│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.downloader.html">downloader.py</a>        <span class="comment"># ⬇️ File download utilities</span>
-│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.linux.html">linux.py</a>             <span class="comment"># 🐧 Linux-specific installer utilities</span>
-│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.main.html">main.py</a>              <span class="comment"># 🚀 Main installer functionality</span>
-│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.windows.html">windows.py</a>           <span class="comment"># 💻 Windows-specific installer utilities</span>
-│   └── ...
-│
-├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.all_doctests.html">all_doctests.py</a>          <span class="comment"># ✅ Execution of all doctests for a given path</span>
-├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.archive.html">archive.py</a>               <span class="comment"># 📦 Archive utilities (zip, repair_zip)</span>
-├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.backup.html">backup.py</a>                <span class="comment"># 📦 Backup utilities (delta backup, consolidate)</span>
-├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.collections.html">collections.py</a>           <span class="comment"># 🧰 Collection utilities (unique_list)</span>
-├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.ctx.html">ctx.py</a>                   <span class="comment"># 🚫 Context managers (Muffle, LogToFile)</span>
-├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.decorators.html">decorators.py</a>            <span class="comment"># 🎯 Decorators (silent, measure_time, error_handler, simple_cache)</span>
-├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.image.html">image.py</a>                 <span class="comment"># 🖼️ Image utilities (image_resize)</span>
-├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.io.html">io.py</a>                    <span class="comment"># 💻 I/O utilities (file management, json)</span>
-├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.parallel.html">parallel.py</a>              <span class="comment"># 🧑‍🤝‍🧑 Parallel processing (multiprocessing, multithreading)</span>
-├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.print.html">print.py</a>                 <span class="comment"># 🖨️ Display utilities (info, debug, warning, error)</span>
-└── ...
-</pre>
-</html>
-## ⭐ Star History
-<html>
-	<a href="https://star-history.com/#Stoupy51/stouputils&Date">
-		<picture>
-			<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date&theme=dark" />
-			<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
-			<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
-		</picture>
-	</a>
-</html>
+# 🛠️ Project Badges
+[![GitHub](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=github&label=GitHub)](https://github.com/Stoupy51/stouputils/releases/latest)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/stouputils?logo=python&label=PyPI%20downloads)](https://pypi.org/project/stouputils/)
+[![Documentation](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=sphinx&label=Documentation&color=purple)](https://stoupy51.github.io/stouputils/latest/)
+<br>
+# 📚 Project Overview
+Stouputils is a collection of utility modules designed to simplify and enhance the development process.<br>
+It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers.
+# 🚀 Project File Tree
+<html>
+<details style="display: none;">
+<summary></summary>
+<style>
+.code-tree {
+	border-radius: 6px;
+	padding: 16px;
+	font-family: monospace;
+	line-height: 1.45;
+	overflow: auto;
+	white-space: pre;
+	background-color:rgb(43, 43, 43);
+	color: #d4d4d4;
+}
+.code-tree a {
+	color: #569cd6;
+	text-decoration: none;
+}
+.code-tree a:hover {
+	text-decoration: underline;
+}
+.code-tree .comment {
+	color:rgb(231, 213, 48);
+}
+</style>
+</details>
+<pre class="code-tree">stouputils/
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.html">applications/</a>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.automatic_docs.html">automatic_docs.py</a>    <span class="comment"># 📚 Documentation generation utilities (used to create this documentation)</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.applications.upscaler.html">upscaler/</a>            <span class="comment"># 🔎 Image & Video upscaler (configurable)</span>
+│   └── ...
+│
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.html">continuous_delivery/</a>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.cd_utils.html">cd_utils.py</a>          <span class="comment"># 🔧 Common utilities for continuous delivery</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.github.html">github.py</a>            <span class="comment"># 📦 GitHub utilities (upload_to_github)</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.pypi.html">pypi.py</a>              <span class="comment"># 📦 PyPI utilities (pypi_full_routine)</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.continuous_delivery.pyproject.html">pyproject.py</a>         <span class="comment"># 📝 Pyproject.toml utilities</span>
+│   └── ...
+│
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.html">data_science/</a>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.config.html">config/</a>              <span class="comment"># ⚙️ Configuration utilities for data science</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.dataset.html">dataset/</a>             <span class="comment"># 📊 Dataset handling (dataset, dataset_loader, grouping_strategy)</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.data_processing.html">data_processing/</a>     <span class="comment"># 🔄 Data processing utilities (image augmentation, preprocessing)</span>
+│   │   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.data_processing.image.html">image/</a>           <span class="comment"># 🖼️ Image processing techniques</span>
+│   │   └── ...
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.html">models/</a>              <span class="comment"># 🧠 ML/DL model interfaces and implementations</span>
+│   │   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.keras.html">keras/</a>           <span class="comment"># 🤖 Keras model implementations</span>
+│   │   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.models.keras_utils.html">keras_utils/</a>     <span class="comment"># 🛠️ Keras utilities (callbacks, losses, visualizations)</span>
+│   │   └── ...
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.scripts.html">scripts/</a>             <span class="comment"># 📜 Data science scripts (augment, preprocess, routine)</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.metric_utils.html">metric_utils.py</a>      <span class="comment"># 📏 Metrics utilities for ML/DL models</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.data_science.mlflow_utils.html">mlflow_utils.py</a>      <span class="comment"># 📊 MLflow integration utilities</span>
+│   └── ...
+│
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.html">installer/</a>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.common.html">common.py</a>            <span class="comment"># 🔧 Common installer utilities</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.downloader.html">downloader.py</a>        <span class="comment"># ⬇️ File download utilities</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.linux.html">linux.py</a>             <span class="comment"># 🐧 Linux-specific installer utilities</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.main.html">main.py</a>              <span class="comment"># 🚀 Main installer functionality</span>
+│   ├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.installer.windows.html">windows.py</a>           <span class="comment"># 💻 Windows-specific installer utilities</span>
+│   └── ...
+│
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.all_doctests.html">all_doctests.py</a>          <span class="comment"># ✅ Execution of all doctests for a given path</span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.archive.html">archive.py</a>               <span class="comment"># 📦 Archive utilities (zip, repair_zip)</span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.backup.html">backup.py</a>                <span class="comment"># 📦 Backup utilities (delta backup, consolidate)</span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.collections.html">collections.py</a>           <span class="comment"># 🧰 Collection utilities (unique_list)</span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.ctx.html">ctx.py</a>                   <span class="comment"># 🚫 Context managers (Muffle, LogToFile)</span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.decorators.html">decorators.py</a>            <span class="comment"># 🎯 Decorators (silent, measure_time, error_handler, simple_cache)</span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.image.html">image.py</a>                 <span class="comment"># 🖼️ Image utilities (image_resize)</span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.io.html">io.py</a>                    <span class="comment"># 💻 I/O utilities (file management, json)</span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.parallel.html">parallel.py</a>              <span class="comment"># 🧑‍🤝‍🧑 Parallel processing (multiprocessing, multithreading)</span>
+├── <a href="https://stoupy51.github.io/stouputils/latest/modules/stouputils.print.html">print.py</a>                 <span class="comment"># 🖨️ Display utilities (info, debug, warning, error)</span>
+└── ...
+</pre>
+</html>
+## ⭐ Star History
+<html>
+	<a href="https://star-history.com/#Stoupy51/stouputils&Date">
+		<picture>
+			<source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date&theme=dark" />
+			<source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
+			<img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
+		</picture>
+	</a>
+</html>

{stouputils-1.4.7 → stouputils-1.4.8}/pyproject.toml RENAMED Viewed

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 [project]
 name = "stouputils"
-version = "1.4.7"
+version = "1.4.8"
 description = "Stouputils is a collection of utility modules designed to simplify and enhance the development process. It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers, and many more."
 readme = "README.md"
 requires-python = ">=3.10"

{stouputils-1.4.7 → stouputils-1.4.8}/stouputils/continuous_delivery/__init__.py RENAMED Viewed

@@ -1,25 +1,25 @@
-""" Continuous delivery and deployment utilities.
-This module provides tools for automating software delivery and deployment:
-Key Features:
-- GitHub release management and uploads
-- PyPI package publishing utilities
-- pyproject.toml file management
-- Common CD/CI utilities
-Components:
-- cd_utils: Common utilities for continuous delivery
-- github: GitHub-specific utilities (upload_to_github)
-- pypi: PyPI publishing tools (pypi_full_routine)
-- pyproject: pyproject.toml file management
-"""
-# ruff: noqa: F403
-# Imports
-from .cd_utils import *
-from .github import *
-from .pypi import *
-from .pyproject import *
+""" Continuous delivery and deployment utilities.
+This module provides tools for automating software delivery and deployment:
+Key Features:
+- GitHub release management and uploads
+- PyPI package publishing utilities
+- pyproject.toml file management
+- Common CD/CI utilities
+Components:
+- cd_utils: Common utilities for continuous delivery
+- github: GitHub-specific utilities (upload_to_github)
+- pypi: PyPI publishing tools (pypi_full_routine)
+- pyproject: pyproject.toml file management
+"""
+# ruff: noqa: F403
+# Imports
+from .cd_utils import *
+from .github import *
+from .pypi import *
+from .pyproject import *

{stouputils-1.4.7 → stouputils-1.4.8}/stouputils/continuous_delivery/cd_utils.py RENAMED Viewed

@@ -1,141 +1,141 @@
-""" This module contains utilities for continuous delivery, such as loading credentials from a file.
-It is mainly used by the `stouputils.continuous_delivery.github` module.
-"""
-# Imports
-import os
-from typing import Any
-import requests
-import yaml
-from ..decorators import handle_error
-from ..io import clean_path, super_json_load
-from ..print import warning
-# Load credentials from file
-@handle_error()
-def load_credentials(credentials_path: str) -> dict[str, Any]:
-	""" Load credentials from a JSON or YAML file into a dictionary.
-	Loads credentials from either a JSON or YAML file and returns them as a dictionary.
-	The file must contain the required credentials in the appropriate format.
-	Args:
-		credentials_path (str): Path to the credentials file (.json or .yml)
-	Returns:
-		dict[str, Any]: Dictionary containing the credentials
-	Example JSON format:
-	.. code-block:: json
-		{
-			"github": {
-				"username": "Stoupy51",
-				"api_key": "ghp_XXXXXXXXXXXXXXXXXXXXXXXXXX"
-			}
-		}
-	Example YAML format:
-	.. code-block:: yaml
-		github:
-			username: "Stoupy51"
-			api_key: "ghp_XXXXXXXXXXXXXXXXXXXXXXXXXX"
-	"""
-	# Get the absolute path of the credentials file
-	warning(
-		"Be cautious when loading credentials from external sources like this, "
-		"as they might contain malicious code that could compromise your credentials without your knowledge"
-	)
-	credentials_path = clean_path(credentials_path)
-	# Check if the file exists
-	if not os.path.exists(credentials_path):
-		raise FileNotFoundError(f"Credentials file not found at '{credentials_path}'")
-	# Load the file if it's a JSON file
-	if credentials_path.endswith(".json"):
-		return super_json_load(credentials_path)
-	# Else, load the file if it's a YAML file
-	elif credentials_path.endswith((".yml", ".yaml")):
-		with open(credentials_path) as f:
-			return yaml.safe_load(f)
-	# Else, raise an error
-	else:
-		raise ValueError("Credentials file must be .json or .yml format")
-# Handle a response
-def handle_response(response: requests.Response, error_message: str) -> None:
-	""" Handle a response from the API by raising an error if the response is not successful (status code not in 200-299).
-	Args:
-		response		(requests.Response): The response from the API
-		error_message	(str): The error message to raise if the response is not successful
-	"""
-	if response.status_code < 200 or response.status_code >= 300:
-		try:
-			raise ValueError(f"{error_message}, response code {response.status_code} with response {response.json()}")
-		except requests.exceptions.JSONDecodeError as e:
-			raise ValueError(f"{error_message}, response code {response.status_code} with response {response.text}") from e
-# Clean a version string
-def clean_version(version: str, keep: str = "") -> str:
-	""" Clean a version string
-	Args:
-		version	(str): The version string to clean
-		keep	(str): The characters to keep in the version string
-	Returns:
-		str: The cleaned version string
-	>>> clean_version("v1.e0.zfezf0.1.2.3zefz")
-	'1.0.0.1.2.3'
-	>>> clean_version("v1.e0.zfezf0.1.2.3zefz", keep="v")
-	'v1.0.0.1.2.3'
-	>>> clean_version("v1.2.3b", keep="ab")
-	'1.2.3b'
-	"""
-	return "".join(c for c in version if c in "0123456789." + keep)
-# Convert a version string to a float
-def version_to_float(version: str) -> float:
-	""" Converts a version string into a float for comparison purposes.
-	The version string is expected to follow the format of major.minor.patch.something_else....,
-	where each part is separated by a dot and can be extended indefinitely.
-	Args:
-		version (str): The version string to convert. (e.g. "v1.0.0.1.2.3")
-	Returns:
-		float: The float representation of the version. (e.g. 0)
-	>>> version_to_float("v1.0.0")
-	1.0
-	>>> version_to_float("v1.0.0.1")
-	1.000000001
-	>>> version_to_float("v2.3.7")
-	2.003007
-	>>> version_to_float("v1.0.0.1.2.3")
-	1.0000000010020031
-	>>> version_to_float("v2.0") > version_to_float("v1.0.0.1")
-	True
-	"""
-	# Clean the version string by keeping only the numbers and dots
-	version = clean_version(version)
-	# Split the version string into parts
-	version_parts: list[str] = version.split(".")
-	total: float = 0.0
-	multiplier: float = 1.0
-	# Iterate over the parts and add lesser and lesser weight to each part
-	for part in version_parts:
-		total += int(part) * multiplier
-		multiplier /= 1_000
-	return total
+""" This module contains utilities for continuous delivery, such as loading credentials from a file.
+It is mainly used by the `stouputils.continuous_delivery.github` module.
+"""
+# Imports
+import os
+from typing import Any
+import requests
+import yaml
+from ..decorators import handle_error
+from ..io import clean_path, super_json_load
+from ..print import warning
+# Load credentials from file
+@handle_error()
+def load_credentials(credentials_path: str) -> dict[str, Any]:
+	""" Load credentials from a JSON or YAML file into a dictionary.
+	Loads credentials from either a JSON or YAML file and returns them as a dictionary.
+	The file must contain the required credentials in the appropriate format.
+	Args:
+		credentials_path (str): Path to the credentials file (.json or .yml)
+	Returns:
+		dict[str, Any]: Dictionary containing the credentials
+	Example JSON format:
+	.. code-block:: json
+		{
+			"github": {
+				"username": "Stoupy51",
+				"api_key": "ghp_XXXXXXXXXXXXXXXXXXXXXXXXXX"
+			}
+		}
+	Example YAML format:
+	.. code-block:: yaml
+		github:
+			username: "Stoupy51"
+			api_key: "ghp_XXXXXXXXXXXXXXXXXXXXXXXXXX"
+	"""
+	# Get the absolute path of the credentials file
+	warning(
+		"Be cautious when loading credentials from external sources like this, "
+		"as they might contain malicious code that could compromise your credentials without your knowledge"
+	)
+	credentials_path = clean_path(credentials_path)
+	# Check if the file exists
+	if not os.path.exists(credentials_path):
+		raise FileNotFoundError(f"Credentials file not found at '{credentials_path}'")
+	# Load the file if it's a JSON file
+	if credentials_path.endswith(".json"):
+		return super_json_load(credentials_path)
+	# Else, load the file if it's a YAML file
+	elif credentials_path.endswith((".yml", ".yaml")):
+		with open(credentials_path) as f:
+			return yaml.safe_load(f)
+	# Else, raise an error
+	else:
+		raise ValueError("Credentials file must be .json or .yml format")
+# Handle a response
+def handle_response(response: requests.Response, error_message: str) -> None:
+	""" Handle a response from the API by raising an error if the response is not successful (status code not in 200-299).
+	Args:
+		response		(requests.Response): The response from the API
+		error_message	(str): The error message to raise if the response is not successful
+	"""
+	if response.status_code < 200 or response.status_code >= 300:
+		try:
+			raise ValueError(f"{error_message}, response code {response.status_code} with response {response.json()}")
+		except requests.exceptions.JSONDecodeError as e:
+			raise ValueError(f"{error_message}, response code {response.status_code} with response {response.text}") from e
+# Clean a version string
+def clean_version(version: str, keep: str = "") -> str:
+	""" Clean a version string
+	Args:
+		version	(str): The version string to clean
+		keep	(str): The characters to keep in the version string
+	Returns:
+		str: The cleaned version string
+	>>> clean_version("v1.e0.zfezf0.1.2.3zefz")
+	'1.0.0.1.2.3'
+	>>> clean_version("v1.e0.zfezf0.1.2.3zefz", keep="v")
+	'v1.0.0.1.2.3'
+	>>> clean_version("v1.2.3b", keep="ab")
+	'1.2.3b'
+	"""
+	return "".join(c for c in version if c in "0123456789." + keep)
+# Convert a version string to a float
+def version_to_float(version: str) -> float:
+	""" Converts a version string into a float for comparison purposes.
+	The version string is expected to follow the format of major.minor.patch.something_else....,
+	where each part is separated by a dot and can be extended indefinitely.
+	Args:
+		version (str): The version string to convert. (e.g. "v1.0.0.1.2.3")
+	Returns:
+		float: The float representation of the version. (e.g. 0)
+	>>> version_to_float("v1.0.0")
+	1.0
+	>>> version_to_float("v1.0.0.1")
+	1.000000001
+	>>> version_to_float("v2.3.7")
+	2.003007
+	>>> version_to_float("v1.0.0.1.2.3")
+	1.0000000010020031
+	>>> version_to_float("v2.0") > version_to_float("v1.0.0.1")
+	True
+	"""
+	# Clean the version string by keeping only the numbers and dots
+	version = clean_version(version)
+	# Split the version string into parts
+	version_parts: list[str] = version.split(".")
+	total: float = 0.0
+	multiplier: float = 1.0
+	# Iterate over the parts and add lesser and lesser weight to each part
+	for part in version_parts:
+		total += int(part) * multiplier
+		multiplier /= 1_000
+	return total

stouputils 1.4.7__tar.gz → 1.4.8__tar.gz

stouputils 1.4.7tar.gz → 1.4.8tar.gz