stouputils 1.9.7__tar.gz → 1.10.0__tar.gz

{stouputils-1.9.7 → stouputils-1.10.0}/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.9.7 → stouputils-1.10.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stouputils
-Version: 1.9.7
+Version: 1.10.0
 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
@@ -9,10 +9,10 @@ License-File: LICENSE
 Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
-Requires-Python: >=3.10
+Requires-Python: >=3.12
 Requires-Dist: argcomplete>=3.0.0
 Requires-Dist: mypy>=1.18.2
-Requires-Dist: numpy
+Requires-Dist: numpy>=2.4.0
 Requires-Dist: opencv-python>=4.0.0
 Requires-Dist: orjson>=3.0.0
 Requires-Dist: pillow>=10.0.0
@@ -40,46 +40,22 @@ Requires-Dist: sphinx-design; extra == 'docs'
 Requires-Dist: sphinx-treeview; extra == 'docs'
 Description-Content-Type: text/markdown
 
-# 🛠️ Project Badges
+
+## 🛠️ 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
+## 📚 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.
-
-## 🔧 Installation
-
-```bash
-pip install stouputils
-```
-
-### ✨ Enable Tab Completion on Linux (Optional)
-
-For a better CLI experience, enable bash tab completion:
-
-```bash
-# Option 1: Using argcomplete's global activation
-activate-global-python-argcomplete --user
-
-# Option 2: Manual setup for bash
-register-python-argcomplete stouputils >> ~/.bashrc
-source ~/.bashrc
-```
-
-After enabling completion, you can use `<TAB>` to autocomplete commands:
-```bash
-stouputils <TAB>        # Shows: --version, -v, all_doctests, backup
-stouputils all_<TAB>    # Completes to: all_doctests
-```
-
-**Note:** Tab completion works best in bash, zsh, Git Bash, or WSL on Windows.
+It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers.<br>
+Start now by installing the package: `pip install stouputils`.<br>
 
+<a href="https://colab.research.google.com/drive/1mJ-KL-zXzIk1oKDxO6FC1SFfm-BVKG-P?usp=sharing" target="_blank" rel="noopener noreferrer" style="text-decoration: none;"><div class="admonition">
+📖 <b>Want to see examples?</b> Check out our <u>Google Colab notebook</u> with practical usage examples!
+</div></a>
 
-# 🚀 Project File Tree
+## 🚀 Project File Tree
 <html>
 <details style="display: none;">
 <summary></summary>
@@ -161,6 +137,33 @@ stouputils all_<TAB>    # Completes to: all_doctests
 </pre>
 </html>
 
+## 🔧 Installation
+
+```bash
+pip install stouputils
+```
+
+### ✨ Enable Tab Completion on Linux (Optional)
+
+For a better CLI experience, enable bash tab completion:
+
+```bash
+# Option 1: Using argcomplete's global activation
+activate-global-python-argcomplete --user
+
+# Option 2: Manual setup for bash
+register-python-argcomplete stouputils >> ~/.bashrc
+source ~/.bashrc
+```
+
+After enabling completion, you can use `<TAB>` to autocomplete commands:
+```bash
+stouputils <TAB>        # Shows: --version, -v, all_doctests, backup
+stouputils all_<TAB>    # Completes to: all_doctests
+```
+
+**Note:** Tab completion works best in bash, zsh, Git Bash, or WSL on Windows.
+
 ## ⭐ Star History
 
 <html>

{stouputils-1.9.7 → stouputils-1.10.0}/README.md

@@ -1,43 +1,19 @@
-# 🛠️ Project Badges
+
+## 🛠️ 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
+## 📚 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.
-
-## 🔧 Installation
-
-```bash
-pip install stouputils
-```
-
-### ✨ Enable Tab Completion on Linux (Optional)
-
-For a better CLI experience, enable bash tab completion:
-
-```bash
-# Option 1: Using argcomplete's global activation
-activate-global-python-argcomplete --user
-
-# Option 2: Manual setup for bash
-register-python-argcomplete stouputils >> ~/.bashrc
-source ~/.bashrc
-```
-
-After enabling completion, you can use `<TAB>` to autocomplete commands:
-```bash
-stouputils <TAB>        # Shows: --version, -v, all_doctests, backup
-stouputils all_<TAB>    # Completes to: all_doctests
-```
-
-**Note:** Tab completion works best in bash, zsh, Git Bash, or WSL on Windows.
+It includes a range of tools for tasks such as execution of doctests, display utilities, decorators, as well as context managers.<br>
+Start now by installing the package: `pip install stouputils`.<br>
 
+<a href="https://colab.research.google.com/drive/1mJ-KL-zXzIk1oKDxO6FC1SFfm-BVKG-P?usp=sharing" target="_blank" rel="noopener noreferrer" style="text-decoration: none;"><div class="admonition">
+📖 <b>Want to see examples?</b> Check out our <u>Google Colab notebook</u> with practical usage examples!
+</div></a>
 
-# 🚀 Project File Tree
+## 🚀 Project File Tree
 <html>
 <details style="display: none;">
 <summary></summary>
@@ -119,6 +95,33 @@ stouputils all_<TAB>    # Completes to: all_doctests
 </pre>
 </html>
 
+## 🔧 Installation
+
+```bash
+pip install stouputils
+```
+
+### ✨ Enable Tab Completion on Linux (Optional)
+
+For a better CLI experience, enable bash tab completion:
+
+```bash
+# Option 1: Using argcomplete's global activation
+activate-global-python-argcomplete --user
+
+# Option 2: Manual setup for bash
+register-python-argcomplete stouputils >> ~/.bashrc
+source ~/.bashrc
+```
+
+After enabling completion, you can use `<TAB>` to autocomplete commands:
+```bash
+stouputils <TAB>        # Shows: --version, -v, all_doctests, backup
+stouputils all_<TAB>    # Completes to: all_doctests
+```
+
+**Note:** Tab completion works best in bash, zsh, Git Bash, or WSL on Windows.
+
 ## ⭐ Star History
 
 <html>

{stouputils-1.9.7 → stouputils-1.10.0}/pyproject.toml

@@ -5,16 +5,16 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.9.7"
+version = "1.10.0"
 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"
+requires-python = ">=3.12"
 classifiers = [
 	"Programming Language :: Python :: 3",
 	"License :: OSI Approved :: MIT License",
 	"Operating System :: OS Independent",
 ]
-dependencies = [ "tqdm>=4.0.0", "requests>=2.20.0", "pyyaml>=6.0.0", "toml>=0.10.0", "pillow>=10.0.0", "numpy", "opencv-python>=4.0.0", "orjson>=3.0.0", "pyfastcopy>=1.0.0", "python-box[all]>=7.0.0", "zarr>=2.18.3", "mypy>=1.18.2", "argcomplete>=3.0.0",]
+dependencies = [ "tqdm>=4.0.0", "requests>=2.20.0", "pyyaml>=6.0.0", "toml>=0.10.0", "pillow>=10.0.0", "numpy>=2.4.0", "opencv-python>=4.0.0", "orjson>=3.0.0", "pyfastcopy>=1.0.0", "python-box[all]>=7.0.0", "zarr>=2.18.3", "mypy>=1.18.2", "argcomplete>=3.0.0",]
 [[project.authors]]
 name = "Stoupy51"
 email = "stoupy51@gmail.com"

{stouputils-1.9.7 → stouputils-1.10.0}/stouputils/applications/automatic_docs.py

@@ -188,6 +188,7 @@ exclude_patterns: list[str] = []
 # HTML output options
 html_theme: str = "{html_theme}"
 html_static_path: list[str] = ["_static"]
+html_css_files: list[str] = ["custom.css"]
 html_logo: str = "{html_logo}"
 html_title: str = "{project}"
 html_favicon: str = "{html_favicon}"
@@ -377,10 +378,14 @@ def generate_index_rst(
 
    modules/{project_module}
 """
+	module_docs = markdown_to_rst(f"""
+Here is the complete unsorted documentation for all modules in the {project} project.<br>
+Prefer to use the search button at the top to find what you need!
+""") + module_docs
 
 	# Convert markdown to RST
 	rst_content: str = f"""
-🛠️ Welcome to {project.capitalize()} Documentation
+✨ Welcome to {project.capitalize()} Documentation ✨
 {'=' * 100}
 {version_selector}
 
@@ -520,6 +525,51 @@ def update_documentation(
 	for dir in [modules_dir, static_dir, templates_dir]:
 		os.makedirs(dir, exist_ok=True)
 
+	# Create custom CSS file to reduce heading sizes
+	custom_css_path: str = f"{static_dir}/custom.css"
+	with super_open(custom_css_path, "w") as f:
+		f.write("""
+/* Custom CSS for Sphinx documentation */
+/* Reduce heading sizes */
+h1 { font-size: 2.0em !important; }
+h2 { font-size: 1.6em !important; }
+h3 { font-size: 1.4em !important; }
+h4 { font-size: 1.2em !important; }
+h5 { font-size: 1.0em !important; }
+h6 { font-size: 0.9em !important; }
+
+/* Gradient animation keyframes */
+@keyframes shine-slide {
+	0% { background-position: -200% center; }
+	100% { background-position: 200% center; }
+}
+
+/* On hover animation for various elements */
+a, h1, h2, h3, h4, h5, h6, .admonition {
+	transition: transform 0.3s;
+	position: relative;
+}
+
+a:hover, h1:hover, h2:hover, h3:hover, h4:hover, h5:hover, h6:hover, .admonition:hover {
+	transform: scale(1.05);
+}
+a:hover {
+	background: linear-gradient(
+		110deg,
+		currentColor 0%,
+		currentColor 40%,
+		white 50%,
+		currentColor 60%,
+		currentColor 100%
+	);
+	background-size: 200% 100%;
+	background-clip: text;
+	-webkit-background-clip: text;
+	-webkit-text-fill-color: transparent;
+	animation: shine-slide 2s linear infinite;
+}
+""")
+
 	# Generate index.rst from README.md
 	readme_path: str = f"{root_path}/README.md"
 	index_path: str = f"{source_dir}/index.rst"

{stouputils-1.9.7 → stouputils-1.10.0}/stouputils/continuous_delivery/pypi.py

@@ -1,90 +1,90 @@
-""" This module contains utilities for PyPI.
-
-- pypi_full_routine: Upload the most recent file(s) to PyPI after updating pip and required packages and building the package
-
-.. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/continuous_delivery/pypi_module.gif
-  :alt: stouputils pypi examples
-"""
-
-# Imports
-import os
-import sys
-from collections.abc import Callable
-
-from ..decorators import LogLevels, handle_error
-
-
-def update_pip_and_required_packages() -> int:
-	""" Update pip and required packages.
-
-	Returns:
-		int: Return code of the os.system call.
-	"""
-	return os.system(f"{sys.executable} -m pip install --upgrade pip setuptools build twine pkginfo packaging")
-
-def build_package() -> int:
-	""" Build the package.
-
-	Returns:
-		int: Return code of the os.system call.
-	"""
-	return os.system(f"{sys.executable} -m build")
-
-def upload_package(repository: str, filepath: str) -> int:
-	""" Upload the package to PyPI.
-
-	Args:
-		repository  (str): Repository to upload to.
-		filepath    (str): Path to the file to upload.
-
-	Returns:
-		int: Return code of the os.system call.
-	"""
-	return os.system(f"{sys.executable} -m twine upload --verbose -r {repository} {filepath}")
-
-@handle_error(message="Error while doing the pypi full routine", error_log=LogLevels.ERROR_TRACEBACK)
-def pypi_full_routine(
-	repository: str,
-	dist_directory: str,
-	last_files: int = 1,
-	endswith: str = ".tar.gz",
-
-	update_all_function: Callable[[], int] = update_pip_and_required_packages,
-	build_package_function: Callable[[], int] = build_package,
-	upload_package_function: Callable[[str, str], int] = upload_package,
-) -> None:
-	""" Upload the most recent file(s) to PyPI after updating pip and required packages and building the package.
-
-	Args:
-		repository               (str):                        Repository to upload to.
-		dist_directory           (str):                        Directory to upload from.
-		last_files               (int):                        Number of most recent files to upload. Defaults to 1.
-		endswith                 (str):                        End of the file name to upload. Defaults to ".tar.gz".
-		update_all_function      (Callable[[], int]):          Function to update pip and required packages.
-			Defaults to :func:`update_pip_and_required_packages`.
-		build_package_function   (Callable[[], int]):          Function to build the package.
-			Defaults to :func:`build_package`.
-		upload_package_function  (Callable[[str, str], int]):  Function to upload the package.
-			Defaults to :func:`upload_package`.
-
-	Returns:
-		int: Return code of the command.
-	"""
-	if update_all_function() != 0:
-		raise Exception("Error while updating pip and required packages")
-
-	if build_package_function() != 0:
-		raise Exception("Error while building the package")
-
-	# Get list of tar.gz files in dist directory sorted by modification time
-	files: list[str] = sorted(
-		[x for x in os.listdir(dist_directory) if x.endswith(endswith)],	# Get list of tar.gz files in dist directory
-		key=lambda x: os.path.getmtime(f"{dist_directory}/{x}"),			# Sort by modification time
-		reverse=True														# Sort in reverse order
-	)
-
-	# Upload the most recent file(s)
-	for file in files[:last_files]:
-		upload_package_function(repository, f"{dist_directory}/{file}")
-
-
+""" This module contains utilities for PyPI.
+
+- pypi_full_routine: Upload the most recent file(s) to PyPI after updating pip and required packages and building the package
+
+.. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/continuous_delivery/pypi_module.gif
+  :alt: stouputils pypi examples
+"""
+
+# Imports
+import os
+import sys
+from collections.abc import Callable
+
+from ..decorators import LogLevels, handle_error
+
+
+def update_pip_and_required_packages() -> int:
+	""" Update pip and required packages.
+
+	Returns:
+		int: Return code of the os.system call.
+	"""
+	return os.system(f"{sys.executable} -m pip install --upgrade pip setuptools build twine pkginfo packaging")
+
+def build_package() -> int:
+	""" Build the package.
+
+	Returns:
+		int: Return code of the os.system call.
+	"""
+	return os.system(f"{sys.executable} -m build")
+
+def upload_package(repository: str, filepath: str) -> int:
+	""" Upload the package to PyPI.
+
+	Args:
+		repository  (str): Repository to upload to.
+		filepath    (str): Path to the file to upload.
+
+	Returns:
+		int: Return code of the os.system call.
+	"""
+	return os.system(f"{sys.executable} -m twine upload --verbose -r {repository} {filepath}")
+
+@handle_error(message="Error while doing the pypi full routine", error_log=LogLevels.ERROR_TRACEBACK)
+def pypi_full_routine(
+	repository: str,
+	dist_directory: str,
+	last_files: int = 1,
+	endswith: str = ".tar.gz",
+
+	update_all_function: Callable[[], int] = update_pip_and_required_packages,
+	build_package_function: Callable[[], int] = build_package,
+	upload_package_function: Callable[[str, str], int] = upload_package,
+) -> None:
+	""" Upload the most recent file(s) to PyPI after updating pip and required packages and building the package.
+
+	Args:
+		repository               (str):                        Repository to upload to.
+		dist_directory           (str):                        Directory to upload from.
+		last_files               (int):                        Number of most recent files to upload. Defaults to 1.
+		endswith                 (str):                        End of the file name to upload. Defaults to ".tar.gz".
+		update_all_function      (Callable[[], int]):          Function to update pip and required packages.
+			Defaults to :func:`update_pip_and_required_packages`.
+		build_package_function   (Callable[[], int]):          Function to build the package.
+			Defaults to :func:`build_package`.
+		upload_package_function  (Callable[[str, str], int]):  Function to upload the package.
+			Defaults to :func:`upload_package`.
+
+	Returns:
+		int: Return code of the command.
+	"""
+	if update_all_function() != 0:
+		raise Exception("Error while updating pip and required packages")
+
+	if build_package_function() != 0:
+		raise Exception("Error while building the package")
+
+	# Get list of tar.gz files in dist directory sorted by modification time
+	files: list[str] = sorted(
+		[x for x in os.listdir(dist_directory) if x.endswith(endswith)],	# Get list of tar.gz files in dist directory
+		key=lambda x: os.path.getmtime(f"{dist_directory}/{x}"),			# Sort by modification time
+		reverse=True														# Sort in reverse order
+	)
+
+	# Upload the most recent file(s)
+	for file in files[:last_files]:
+		upload_package_function(repository, f"{dist_directory}/{file}")
+
+