PyPI - stouputils - Versions diffs - 1.8.0__tar.gz → 1.9.1__tar.gz - Mend

stouputils 1.8.0tar.gz → 1.9.1tar.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 (140) hide show

{stouputils-1.8.0 → stouputils-1.9.1}/PKG-INFO RENAMED Viewed

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stouputils
-Version: 1.8.0
+Version: 1.9.1
 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,6 +10,7 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.10
+Requires-Dist: argcomplete>=3.0.0
 Requires-Dist: mypy>=1.18.2
 Requires-Dist: numpy
 Requires-Dist: opencv-python>=4.0.0
@@ -50,6 +51,33 @@ Description-Content-Type: text/markdown
 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.
 # 🚀 Project File Tree
 <html>

{stouputils-1.8.0 → stouputils-1.9.1}/README.md RENAMED Viewed

@@ -9,6 +9,33 @@
 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.
 # 🚀 Project File Tree
 <html>

{stouputils-1.8.0 → stouputils-1.9.1}/pyproject.toml RENAMED Viewed

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 [project]
 name = "stouputils"
-version = "1.8.0"
+version = "1.9.1"
 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"
@@ -14,7 +14,7 @@ classifiers = [
 	"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",]
+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",]
 [[project.authors]]
 name = "Stoupy51"
 email = "stoupy51@gmail.com"

stouputils-1.9.1/stouputils/__main__.py ADDED Viewed

@@ -0,0 +1,67 @@
+# PYTHON_ARGCOMPLETE_OK
+# Imports
+import argparse
+import sys
+import argcomplete
+from .all_doctests import launch_tests
+from .backup import backup_cli
+from .decorators import handle_error
+from .print import CYAN, GREEN, RESET, show_version
+# Argument Parser Setup for Auto-Completion
+parser = argparse.ArgumentParser(prog="stouputils", add_help=False)
+parser.add_argument("command", nargs="?", choices=["--version", "-v", "all_doctests", "backup"])
+parser.add_argument("args", nargs="*")
+argcomplete.autocomplete(parser)
+@handle_error(message="Error while running 'stouputils'")
+def main() -> None:
+	second_arg: str = sys.argv[1].lower() if len(sys.argv) >= 2 else ""
+	# Print the version of stouputils and its dependencies
+	if second_arg in ("--version","-v"):
+		return show_version()
+	# Handle "all_doctests" command
+	if second_arg == "all_doctests":
+		if launch_tests("." if len(sys.argv) == 2 else sys.argv[2]) > 0:
+			sys.exit(1)
+		return
+	# Handle "backup" command
+	if second_arg == "backup":
+		sys.argv.pop(1)  # Remove "backup" from argv so backup_cli gets clean arguments
+		return backup_cli()
+	# Check if the command is any package name
+	if second_arg in (): # type: ignore
+		return
+	# Get version
+	from importlib.metadata import version
+	try:
+		pkg_version = version("stouputils")
+	except Exception:
+		pkg_version = "unknown"
+	# Print help with nice formatting
+	separator: str = "─" * 60
+	print(f"{CYAN}{separator}{RESET}")
+	print(f"{CYAN}stouputils {GREEN}CLI {CYAN}v{pkg_version}{RESET}")
+	print(f"{CYAN}{separator}{RESET}")
+	print(f"\n{CYAN}Usage:{RESET} stouputils <command> [options]")
+	print(f"\n{CYAN}Available commands:{RESET}")
+	print(f"  {GREEN}--version, -v{RESET}       Show version information")
+	print(f"  {GREEN}all_doctests{RESET} [dir]  Run all doctests in the specified directory")
+	print(f"  {GREEN}backup{RESET} --help       Backup utilities (delta, consolidate, limit)")
+	print(f"{CYAN}{separator}{RESET}")
+	return
+if __name__ == "__main__":
+	main()

{stouputils-1.8.0 → stouputils-1.9.1}/stouputils/all_doctests.py RENAMED Viewed

@@ -103,7 +103,7 @@ def launch_tests(root_dir: str, strict: bool = True) -> int:
 	for module_path in modules_file_paths:
 		separator: str = " " * (max_length - len(module_path))
-		@measure_time(progress, message=f"Importing module '{module_path}' {separator}took")
+		@measure_time(message=f"Importing module '{module_path}' {separator}took")
 		def internal(a: str = module_path, b: str = separator) -> None:
 			modules.append(importlib.import_module(a))
 			separators.append(b)
@@ -153,7 +153,7 @@ def test_module_with_progress(module: ModuleType, separator: str) -> "TestResult
 		TestResults: The results of the tests
 	"""
 	from doctest import TestResults, testmod
-	@measure_time(progress, message=f"Testing module '{module.__name__}' {separator}took")
+	@measure_time(message=f"Testing module '{module.__name__}' {separator}took")
 	def internal() -> TestResults:
 		return testmod(m=module)
 	return internal()

{stouputils-1.8.0 → stouputils-1.9.1}/stouputils/applications/automatic_docs.py RENAMED Viewed

@@ -235,6 +235,15 @@ autodoc_default_options: dict[str, bool | str] = {{
 autodoc_mock_imports = []
 always_document_param_types = True
 add_module_names = False
+# Prevent social media cards and images from being used
+html_meta = globals().get("html_meta", {{}})
+html_meta.pop("image", None)
+html_context = globals().get("html_context", {{}})
+html_context.pop("image", None)
+html_context.pop("social_card", None)
+ogp_social_cards = {{"enable": False}}
+ogp_site_url = ""
 """
 	if skip_undocumented:

{stouputils-1.8.0 → stouputils-1.9.1}/stouputils/continuous_delivery/github.py RENAMED Viewed

@@ -286,6 +286,12 @@ def generate_changelog(
 		if ":" in message:
 			commit_type_part, desc = message.split(":", 1)
+			# Check for breaking change indicator (!)
+			is_breaking: bool = False
+			if "!" in commit_type_part:
+				is_breaking = True
+				commit_type_part = commit_type_part.replace("!", "")
 			# Extract sub-category if present (e.g., 'feat(Project)' -> 'feat', 'Project')
 			sub_category: str|None = None
 			if "(" in commit_type_part and ")" in commit_type_part:
@@ -301,10 +307,13 @@ def generate_changelog(
 			commit_type = "".join(c for c in commit_type.lower().strip() if c in "abcdefghijklmnopqrstuvwxyz")
 			commit_type = COMMIT_TYPES.get(commit_type, commit_type.title())
+			# Prepend emoji if breaking change
+			formatted_desc = f"🚨 {desc.strip()}" if is_breaking else desc.strip()
 			# Add the commit to the commit groups
 			if commit_type not in commit_groups:
 				commit_groups[commit_type] = []
-			commit_groups[commit_type].append((desc.strip(), sha, sub_category))
+			commit_groups[commit_type].append((formatted_desc, sha, sub_category))
 	# Initialize the changelog
 	changelog: str = "## Changelog\n\n"
@@ -460,7 +469,7 @@ def upload_assets(
 				handle_response(response, f"Failed to upload {file}")
 				progress(f"Uploaded {file}")
-@measure_time(progress, "Uploading to GitHub took")
+@measure_time(message="Uploading to GitHub took")
 @handle_error()
 def upload_to_github(credentials: dict[str, Any], github_config: dict[str, Any]) -> str:
 	""" Upload the project to GitHub using the credentials and the configuration

stouputils 1.8.0__tar.gz → 1.9.1__tar.gz

stouputils 1.8.0tar.gz → 1.9.1tar.gz