stouputils 1.2.4__tar.gz → 1.2.5__tar.gz

{stouputils-1.2.4 → stouputils-1.2.5}/.gitignore

@@ -1,14 +1,14 @@
-
-# Python
-*__pycache__/
-
-# Miscellaneous
-__temporary__/
-output.log
-
-# Documentation
-docs/source/_static/
-docs/source/_templates/
-docs/source/modules/
-docs/source/index.rst
-
+
+# Python
+*__pycache__/
+
+# Miscellaneous
+__temporary__/
+output.log
+
+# Documentation
+docs/source/_static/
+docs/source/_templates/
+docs/source/modules/
+docs/source/index.rst
+

{stouputils-1.2.4 → stouputils-1.2.5}/LICENSE

@@ -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.2.4 → stouputils-1.2.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stouputils
-Version: 1.2.4
+Version: 1.2.5
 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
@@ -10,9 +10,14 @@ 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: hatch>=1.14.0
 Requires-Dist: m2r2>=0.3.3.post2
+Requires-Dist: myst-parser>=4.0.1
 Requires-Dist: pyyaml>=6.0.0
 Requires-Dist: requests>=2.30.0
+Requires-Dist: sphinx-rtd-theme>=3.0.2
+Requires-Dist: sphinx>=8.1.3
 Requires-Dist: toml>=0.10.0
 Requires-Dist: tqdm>=4.66.0
 Description-Content-Type: text/markdown

{stouputils-1.2.4 → stouputils-1.2.5}/README.md

@@ -1,51 +1,51 @@
-
-# 🛠️ 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>
-
+
+# 🛠️ 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.4 → stouputils-1.2.5}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.2.4"
+version = "1.2.5"
 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"
@@ -20,6 +20,11 @@ dependencies = [
 	"pyyaml>=6.0.0",
 	"toml>=0.10.0",
 	"m2r2>=0.3.3.post2",
+	"sphinx>=8.1.3",
+	"sphinx-rtd-theme>=3.0.2",
+	"myst-parser>=4.0.1",
+	"furo>=2024.8.6",
+	"hatch>=1.14.0",
 ]
 [[project.authors]]
 name = "Stoupy51"

{stouputils-1.2.4 → stouputils-1.2.5}/stouputils/__init__.py

@@ -1,31 +1,31 @@
-""" A collection of utility modules designed to simplify and enhance the development process.
-
-This package provides various tools and utilities for common development tasks including:
-
-Key Features:
-- Continuous delivery utilities (GitHub, PyPI)
-- Display and logging utilities (print)
-- File and I/O management (io)
-- Decorators for common patterns
-- Context managers
-- Archive and backup tools
-- Parallel processing helpers
-- Collection utilities
-- Doctests utilities
-
-"""
-
-# Imports
-from .print import *
-from .archive import *
-from .io import *
-from .decorators import *
-from .ctx import *
-from .parallel import *
-from .all_doctests import *
-from .collections import *
-from .backup import *
-
-# Folders
-from .continuous_delivery import *
-
+""" A collection of utility modules designed to simplify and enhance the development process.
+
+This package provides various tools and utilities for common development tasks including:
+
+Key Features:
+- Continuous delivery utilities (GitHub, PyPI)
+- Display and logging utilities (print)
+- File and I/O management (io)
+- Decorators for common patterns
+- Context managers
+- Archive and backup tools
+- Parallel processing helpers
+- Collection utilities
+- Doctests utilities
+
+"""
+
+# Imports
+from .print import *
+from .archive import *
+from .io import *
+from .decorators import *
+from .ctx import *
+from .parallel import *
+from .all_doctests import *
+from .collections import *
+from .backup import *
+
+# Folders
+from .continuous_delivery import *
+

{stouputils-1.2.4 → stouputils-1.2.5}/stouputils/all_doctests.py

@@ -1,98 +1,98 @@
-"""
-This module is used to run all the doctests for all the modules in a given directory.
-
-.. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/all_doctests_module.gif
-  :alt: stouputils all_doctests examples
-"""
-
-# Imports
-import os
-import sys
-from .print import info, error, progress
-from .decorators import measure_time, handle_error, LogLevels
-from . import decorators
-from doctest import TestResults, testmod
-from types import ModuleType
-import importlib
-import pkgutil
-
-def test_module_with_progress(module: ModuleType, separator: str) -> TestResults:
-	@measure_time(progress, message=f"Testing module '{module.__name__}' {separator}took")
-	def internal() -> TestResults:
-		return testmod(m=module)
-	return internal()
-
-# Main program
-def launch_tests(root_dir: str, importing_errors: LogLevels = LogLevels.WARNING_TRACEBACK, strict: bool = True) -> None:
-	""" Main function to launch tests for all modules in the given directory.
-
-	Args:
-		root_dir				(str):			Root directory to search for modules
-		importing_errors		(LogLevels):	Log level for the errors when importing modules
-		strict					(bool):			Modify the force_raise_exception variable to True in the decorators module
-	
-	Examples:
-		>>> launch_tests("unknown_dir")
-		Traceback (most recent call last):
-			...
-		ValueError: No modules found in 'unknown_dir'
-
-	.. code-block:: python
-
-		> launch_tests("/path/to/source")
-		[PROGRESS HH:MM:SS] Importing module 'module1'	took 0.001s
-		[PROGRESS HH:MM:SS] Importing module 'module2'	took 0.002s
-		[PROGRESS HH:MM:SS] Importing module 'module3'	took 0.003s
-		[PROGRESS HH:MM:SS] Importing module 'module4'	took 0.004s
-		[INFO HH:MM:SS] Testing 4 modules...
-		[PROGRESS HH:MM:SS] Testing module 'module1'	took 0.005s
-		[PROGRESS HH:MM:SS] Testing module 'module2'	took 0.006s
-		[PROGRESS HH:MM:SS] Testing module 'module3'	took 0.007s
-		[PROGRESS HH:MM:SS] Testing module 'module4'	took 0.008s
-	"""
-	if strict:
-		old_value: bool = strict
-		decorators.force_raise_exception = True
-		strict = old_value
-
-
-	# Get all modules from folder
-	sys.path.insert(0, root_dir)
-	modules_file_paths: list[str] = []
-	for directory_path, _, _ in os.walk(root_dir):
-		for module_info in pkgutil.walk_packages([directory_path]):
-			absolute_module_path: str = os.path.join(directory_path, module_info.name)
-			path: str = absolute_module_path.split(root_dir, 1)[1].replace(os.sep, ".")[1:]
-			if path not in modules_file_paths:
-				modules_file_paths.append(path)
-	if not modules_file_paths:
-		raise ValueError(f"No modules found in '{root_dir}'")
-
-	# Find longest module path for alignment
-	max_length: int = max(len(path) for path in modules_file_paths)
-
-	# Dynamically import all modules from iacob package recursively using pkgutil and importlib
-	modules: list[ModuleType] = []
-	separators: list[str] = []
-	for module_path in modules_file_paths:
-		separator: str = " " * (max_length - len(module_path))
-		@handle_error(error_log=importing_errors)
-		@measure_time(progress, message=f"Importing module '{module_path}' {separator}took")
-		def internal() -> None:
-			modules.append(importlib.import_module(module_path))
-			separators.append(separator)
-		internal()
-
-	# Run tests for each module
-	info(f"Testing {len(modules)} modules...")
-	separators = [s + " "*(len("Importing") - len("Testing")) for s in separators]
-	results: list[TestResults] = [test_module_with_progress(module, separator) for module, separator in zip(modules, separators)]
-
-	# Display any error lines for each module at the end of the script
-	for module, result in zip(modules, results):
-		if result.failed > 0:
-			error(f"Errors in module {module.__name__}", exit=False)
-
-	# Reset force_raise_exception back
-	decorators.force_raise_exception = strict
-
+"""
+This module is used to run all the doctests for all the modules in a given directory.
+
+.. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/all_doctests_module.gif
+  :alt: stouputils all_doctests examples
+"""
+
+# Imports
+import os
+import sys
+from .print import info, error, progress
+from .decorators import measure_time, handle_error, LogLevels
+from . import decorators
+from doctest import TestResults, testmod
+from types import ModuleType
+import importlib
+import pkgutil
+
+def test_module_with_progress(module: ModuleType, separator: str) -> TestResults:
+	@measure_time(progress, message=f"Testing module '{module.__name__}' {separator}took")
+	def internal() -> TestResults:
+		return testmod(m=module)
+	return internal()
+
+# Main program
+def launch_tests(root_dir: str, importing_errors: LogLevels = LogLevels.WARNING_TRACEBACK, strict: bool = True) -> None:
+	""" Main function to launch tests for all modules in the given directory.
+
+	Args:
+		root_dir				(str):			Root directory to search for modules
+		importing_errors		(LogLevels):	Log level for the errors when importing modules
+		strict					(bool):			Modify the force_raise_exception variable to True in the decorators module
+	
+	Examples:
+		>>> launch_tests("unknown_dir")
+		Traceback (most recent call last):
+			...
+		ValueError: No modules found in 'unknown_dir'
+
+	.. code-block:: python
+
+		> launch_tests("/path/to/source")
+		[PROGRESS HH:MM:SS] Importing module 'module1'	took 0.001s
+		[PROGRESS HH:MM:SS] Importing module 'module2'	took 0.002s
+		[PROGRESS HH:MM:SS] Importing module 'module3'	took 0.003s
+		[PROGRESS HH:MM:SS] Importing module 'module4'	took 0.004s
+		[INFO HH:MM:SS] Testing 4 modules...
+		[PROGRESS HH:MM:SS] Testing module 'module1'	took 0.005s
+		[PROGRESS HH:MM:SS] Testing module 'module2'	took 0.006s
+		[PROGRESS HH:MM:SS] Testing module 'module3'	took 0.007s
+		[PROGRESS HH:MM:SS] Testing module 'module4'	took 0.008s
+	"""
+	if strict:
+		old_value: bool = strict
+		decorators.force_raise_exception = True
+		strict = old_value
+
+
+	# Get all modules from folder
+	sys.path.insert(0, root_dir)
+	modules_file_paths: list[str] = []
+	for directory_path, _, _ in os.walk(root_dir):
+		for module_info in pkgutil.walk_packages([directory_path]):
+			absolute_module_path: str = os.path.join(directory_path, module_info.name)
+			path: str = absolute_module_path.split(root_dir, 1)[1].replace(os.sep, ".")[1:]
+			if path not in modules_file_paths:
+				modules_file_paths.append(path)
+	if not modules_file_paths:
+		raise ValueError(f"No modules found in '{root_dir}'")
+
+	# Find longest module path for alignment
+	max_length: int = max(len(path) for path in modules_file_paths)
+
+	# Dynamically import all modules from iacob package recursively using pkgutil and importlib
+	modules: list[ModuleType] = []
+	separators: list[str] = []
+	for module_path in modules_file_paths:
+		separator: str = " " * (max_length - len(module_path))
+		@handle_error(error_log=importing_errors)
+		@measure_time(progress, message=f"Importing module '{module_path}' {separator}took")
+		def internal() -> None:
+			modules.append(importlib.import_module(module_path))
+			separators.append(separator)
+		internal()
+
+	# Run tests for each module
+	info(f"Testing {len(modules)} modules...")
+	separators = [s + " "*(len("Importing") - len("Testing")) for s in separators]
+	results: list[TestResults] = [test_module_with_progress(module, separator) for module, separator in zip(modules, separators)]
+
+	# Display any error lines for each module at the end of the script
+	for module, result in zip(modules, results):
+		if result.failed > 0:
+			error(f"Errors in module {module.__name__}", exit=False)
+
+	# Reset force_raise_exception back
+	decorators.force_raise_exception = strict
+

{stouputils-1.2.4 → stouputils-1.2.5}/stouputils/applications/automatic_docs.py

@@ -447,7 +447,8 @@ def update_documentation(
 	version = version.replace("v", "") if isinstance(version, str) else version
 
 	# Modify build directory if version is specified
-	build_dir: str = f"{html_dir}/latest" if not version else f"{html_dir}/v{version}"
+	latest_dir: str = f"{html_dir}/latest"
+	build_dir: str = latest_dir if not version else f"{html_dir}/v{version}"
 	
 	# Create directories if they don't exist
 	for dir in [modules_dir, static_dir, templates_dir]:
@@ -502,6 +503,12 @@ def update_documentation(
 	# Add index.html to the build directory that redirects to the latest version
 	generate_redirect_function(f"{html_dir}/index.html")
 
+	# If version is specified, copy the build directory to latest too
+	# This is useful for GitHub Actions to prevent re-building the documentation from scratch without the version
+	if version:
+		shutil.rmtree(latest_dir)
+		shutil.copytree(build_dir, latest_dir)
+
 	info(f"Documentation updated successfully!")
 	info(f"You can view the documentation by opening {build_dir}/index.html")