stouputils 1.2.25__tar.gz → 1.2.26__tar.gz

stouputils-1.2.26/PKG-INFO

@@ -0,0 +1,101 @@
+Metadata-Version: 2.4
+Name: stouputils
+Version: 1.2.26
+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
+Author-email: Stoupy51 <stoupy51@gmail.com>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: furo>=2024.8.6
+Requires-Dist: m2r2>=0.3.3.post2
+Requires-Dist: myst-parser>=4.0.0
+Requires-Dist: numpy
+Requires-Dist: opencv-python>=4.0.0
+Requires-Dist: pillow>=11.0.0
+Requires-Dist: pydata-sphinx-theme>=0.11.0
+Requires-Dist: pyyaml>=6.0.0
+Requires-Dist: requests>=2.30.0
+Requires-Dist: sphinx-rtd-theme>=3.0.0
+Requires-Dist: sphinx>=8.0.0
+Requires-Dist: toml>=0.10.0
+Requires-Dist: tqdm>=4.0.0
+Description-Content-Type: text/markdown
+
+# 🛠️ 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
+
+<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>
+
+<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.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.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>
+
+## ⭐ 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.2.26/README.md

@@ -0,0 +1,74 @@
+# 🛠️ 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
+
+<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>
+
+<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.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.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>
+
+## ⭐ 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.2.25 → stouputils-1.2.26}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.2.25"
+version = "1.2.26"
 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"
@@ -21,7 +21,7 @@ dependencies = [
 	"toml>=0.10.0",
 	"m2r2>=0.3.3.post2",
 	"sphinx>=8.0.0",
-	"myst-parser>=4.0.0",
+	"myst_parser>=4.0.0",
 	"sphinx_rtd_theme>=3.0.0",
 	"pydata_sphinx_theme>=0.11.0",
 	"furo>=2024.8.6",

{stouputils-1.2.25 → stouputils-1.2.26}/stouputils/applications/automatic_docs.py

@@ -52,7 +52,7 @@ Example of GitHub Actions workflow:
         - uses: actions/setup-python@v5
         - name: Install dependencies
           run: |
-            pip install stouputils
+            pip install stouputils m2r2 sphinx myst_parser sphinx_rtd_theme pydata_sphinx_theme furo
         - name: Build version docs
           run: |
             python scripts/create_docs.py ${GITHUB_REF#refs/tags/v}
@@ -73,10 +73,24 @@ import sys
 from typing import Any, Callable
 
 from ..io import clean_path, super_open, super_json_dump
-from ..decorators import handle_error, simple_cache
+from ..decorators import handle_error, simple_cache, LogLevels
 from ..continuous_delivery import version_to_float
 from ..print import info
 
+# Constants
+REQUIREMENTS: list[str] = ["m2r2", "sphinx", "myst_parser", "sphinx_rtd_theme", "pydata_sphinx_theme", "furo"]
+""" List of requirements for automatic_docs to work. """
+
+# Functions
+def check_dependencies() -> None:
+	""" Check for each requirement if it is installed. """
+	import importlib
+	for requirement in REQUIREMENTS:
+		try:
+			importlib.import_module(requirement)
+		except ImportError:
+			requirements_str: str = " ".join(REQUIREMENTS)
+			raise ImportError(f"{requirement} is not installed. Please install it the following requirements to use automatic_docs: '{requirements_str}'")
 
 def get_sphinx_conf_content(
 	project: str,
@@ -368,7 +382,7 @@ def generate_redirect_html(filepath: str) -> None:
 </html>
 """)
 
-@handle_error()
+@handle_error(error_log=LogLevels.WARNING_TRACEBACK)
 def update_documentation(
 	root_path: str,
 	project: str,
@@ -411,6 +425,8 @@ def update_documentation(
 		generate_redirect_function (Callable[[str], None]): Function to create redirect file
 		get_conf_content_function  (Callable[..., str]): Function to get Sphinx conf.py content
 	"""
+	check_dependencies()
+
 	# Setup paths
 	root_path = clean_path(root_path)
 	docs_dir: str = f"{root_path}/docs"

stouputils-1.2.25/PKG-INFO

@@ -1,78 +0,0 @@
-Metadata-Version: 2.4
-Name: stouputils
-Version: 1.2.25
-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
-Author-email: Stoupy51 <stoupy51@gmail.com>
-License-File: LICENSE
-Classifier: License :: OSI Approved :: MIT License
-Classifier: Operating System :: OS Independent
-Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.10
-Requires-Dist: furo>=2024.8.6
-Requires-Dist: m2r2>=0.3.3.post2
-Requires-Dist: myst-parser>=4.0.0
-Requires-Dist: numpy
-Requires-Dist: opencv-python>=4.0.0
-Requires-Dist: pillow>=11.0.0
-Requires-Dist: pydata-sphinx-theme>=0.11.0
-Requires-Dist: pyyaml>=6.0.0
-Requires-Dist: requests>=2.30.0
-Requires-Dist: sphinx-rtd-theme>=3.0.0
-Requires-Dist: sphinx>=8.0.0
-Requires-Dist: toml>=0.10.0
-Requires-Dist: tqdm>=4.0.0
-Description-Content-Type: text/markdown
-
-
-# 🛠️ 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/)
-
-
-# 📚 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
-```bash
-stouputils/
-├── applications/
-│   ├── automatic_docs.py    # 📚 Documentation generation utilities (used to create this documentation)
-│   └── ...
-│
-├── continuous_delivery/
-│   ├── cd_utils.py          # 🔧 Common utilities for continuous delivery
-│   ├── github.py            # 📦 GitHub utilities (upload_to_github)
-│   ├── pypi.py              # 📦 PyPI utilities (pypi_full_routine)
-│   ├── pyproject.py         # 📝 Pyproject.toml utilities
-│   └── ...
-│
-├── print.py                 # 🖨️ Display utilities (info, debug, warning, error)
-├── io.py                    # 💻 I/O utilities (file management, json)
-├── decorators.py            # 🎯 Decorators (silent, measure_time, error_handler, simple_cache)
-├── ctx.py                   # 🚫 Context managers (Muffle, LogToFile)
-├── archive.py               # 📦 Archive utilities (zip, repair_zip)
-├── parallel.py              # 🧑‍🤝‍🧑 Parallel processing (multiprocessing, multithreading)
-├── collections.py           # 🧰 Collection utilities (unique_list)
-├── all_doctests.py          # ✅ Execution of all doctests for a given path
-├── backup.py                # 📦 Backup utilities (delta backup, consolidate)
-└── ...
-```
-
-
-## ⭐ 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.2.25/README.md

@@ -1,51 +0,0 @@
-
-# 🛠️ 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/)
-
-
-# 📚 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
-```bash
-stouputils/
-├── applications/
-│   ├── automatic_docs.py    # 📚 Documentation generation utilities (used to create this documentation)
-│   └── ...
-│
-├── continuous_delivery/
-│   ├── cd_utils.py          # 🔧 Common utilities for continuous delivery
-│   ├── github.py            # 📦 GitHub utilities (upload_to_github)
-│   ├── pypi.py              # 📦 PyPI utilities (pypi_full_routine)
-│   ├── pyproject.py         # 📝 Pyproject.toml utilities
-│   └── ...
-│
-├── print.py                 # 🖨️ Display utilities (info, debug, warning, error)
-├── io.py                    # 💻 I/O utilities (file management, json)
-├── decorators.py            # 🎯 Decorators (silent, measure_time, error_handler, simple_cache)
-├── ctx.py                   # 🚫 Context managers (Muffle, LogToFile)
-├── archive.py               # 📦 Archive utilities (zip, repair_zip)
-├── parallel.py              # 🧑‍🤝‍🧑 Parallel processing (multiprocessing, multithreading)
-├── collections.py           # 🧰 Collection utilities (unique_list)
-├── all_doctests.py          # ✅ Execution of all doctests for a given path
-├── backup.py                # 📦 Backup utilities (delta backup, consolidate)
-└── ...
-```
-
-
-## ⭐ 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>
-