stouputils 1.5.2__tar.gz → 1.5.4__tar.gz

{stouputils-1.5.2 → stouputils-1.5.4}/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.5.2 → stouputils-1.5.4}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stouputils
-Version: 1.5.2
+Version: 1.5.4
 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.5.2 → stouputils-1.5.4}/pyproject.toml

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.5.2"
+version = "1.5.4"
 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.5.2 → stouputils-1.5.4}/stouputils/continuous_delivery/__init__.py

@@ -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.5.2 → stouputils-1.5.4}/stouputils/continuous_delivery/cd_utils.py

@@ -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.5.2 → stouputils-1.5.4}/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}")
+
+