stouputils 1.0.22__tar.gz → 1.0.23__tar.gz

{stouputils-1.0.22 → stouputils-1.0.23}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stouputils
-Version: 1.0.22
+Version: 1.0.23
 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,8 +10,9 @@ Classifier: License :: OSI Approved :: MIT License
 Classifier: Operating System :: OS Independent
 Classifier: Programming Language :: Python :: 3
 Requires-Python: >=3.10
-Requires-Dist: pyyaml>=6.0.2
+Requires-Dist: pyyaml
 Requires-Dist: requests>=2.31.0
+Requires-Dist: toml
 Requires-Dist: tqdm>=4.66.4
 Description-Content-Type: text/markdown
 

stouputils-1.0.23/build_all_in_one.py

@@ -0,0 +1,20 @@
+
+# Imports
+import stouputils as stp
+
+# Constants
+ROOT: str = stp.get_root_path(__file__)
+REPOSITORY: str = "stouputils"
+DIST_DIRECTORY: str = f"{ROOT}/dist"
+LAST_FILES: int = 1
+ENDWITH: str = ".tar.gz"
+
+if __name__ == "__main__":
+
+	stp.pypi_full_routine(
+		repository=REPOSITORY,
+		dist_directory=DIST_DIRECTORY,
+		last_files=LAST_FILES,
+		endswith=ENDWITH,
+	)
+

{stouputils-1.0.22 → stouputils-1.0.23}/examples/all_doctests.py

@@ -1,15 +1,11 @@
 
 # Imports
-import os
 import stouputils as stp
 
-# Constants
-ROOT: str = os.path.dirname(os.path.abspath(__file__))
-FOLDER_TO_TEST: str = f"{ROOT}/../src"
-
 # Main
 @stp.measure_time(stp.info, message="All doctests finished")
 def main() -> None:
+	FOLDER_TO_TEST: str = stp.get_root_path(__file__, 1) + "/src"
 	stp.launch_tests(FOLDER_TO_TEST)
 
 if __name__ == "__main__":

{stouputils-1.0.22 → stouputils-1.0.23}/pyproject.toml

@@ -1,27 +1,18 @@
-
 [build-system]
-requires = ["hatchling"]
+requires = [ "hatchling",]
 build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.0.22"
-authors = [
-	{ name="Stoupy51", email="stoupy51@gmail.com" },
-]
+version = "1.0.23"
 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"
-classifiers = [
-	"Programming Language :: Python :: 3",
-	"License :: OSI Approved :: MIT License",
-	"Operating System :: OS Independent",
-]
-dependencies = [
-	"tqdm>=4.66.4",
-	"requests>=2.31.0",
-	"pyyaml>=6.0.2",
-]
+classifiers = [ "Programming Language :: Python :: 3", "License :: OSI Approved :: MIT License", "Operating System :: OS Independent",]
+dependencies = [ "tqdm>=4.66.4", "requests>=2.31.0", "pyyaml", "toml",]
+[[project.authors]]
+name = "Stoupy51"
+email = "stoupy51@gmail.com"
 
 [project.urls]
 Homepage = "https://github.com/Stoupy51/stouputils"
@@ -29,4 +20,3 @@ Issues = "https://github.com/Stoupy51/stouputils/issues"
 
 [tool.pyright]
 typeCheckingMode = "strict"
-

{stouputils-1.0.22 → stouputils-1.0.23}/src/stouputils/archive.py

@@ -1,8 +1,8 @@
 """
 This module provides functions for creating and managing archives.
 
-- make_archive: Make an archive with consistency using FILES_TO_WRITE variable
-- repair_zip_file: Try to repair a corrupted zip file (NOT IMPLEMENTED)
+- make_archive: Create a zip archive from a source directory with consistent file timestamps.
+- repair_zip_file: Try to repair a corrupted zip file by ignoring some of the errors
 
 .. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/archive_module.gif
   :alt: stouputils archive examples

{stouputils-1.0.22 → stouputils-1.0.23}/src/stouputils/continuous_delivery/__init__.py

@@ -2,4 +2,6 @@
 # Imports
 from .cd_utils import *
 from .github import *
+from .pypi import *
+from .pyproject import *
 

stouputils-1.0.23/src/stouputils/continuous_delivery/pypi.py

@@ -0,0 +1,85 @@
+""" 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 ..decorators import handle_error, LogLevels
+from typing import Callable
+
+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")
+
+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 update_pip_and_required_packages.
+		build_package_function  (Callable[[], int]):            Function to build the package. Defaults to build_package.
+		upload_package_function (Callable[[str, str], int]):    Function to upload the package. Defaults to 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}")
+
+

stouputils-1.0.23/src/stouputils/continuous_delivery/pyproject.py

@@ -0,0 +1,69 @@
+""" This module contains utilities for reading and writing pyproject.toml files.
+
+- read_pyproject: Read the pyproject.toml file.
+- write_pyproject: Write to the pyproject.toml file.
+
+.. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/continuous_delivery/pyproject_module.gif
+  :alt: stouputils pyproject examples
+"""
+
+# Imports
+from ..io import super_open
+from typing import Any
+import toml
+
+def read_pyproject(pyproject_path: str) -> dict[str, Any]:
+	""" Read the pyproject.toml file.
+
+	Args:
+		pyproject_path: Path to the pyproject.toml file.
+
+	Returns:
+		dict[str, Any]: The content of the pyproject.toml file.
+	"""
+	return toml.load(pyproject_path)
+
+def write_pyproject(pyproject_path: str, pyproject_content: dict[str, Any]) -> None:
+	""" Write to the pyproject.toml file.
+
+	Args:
+		pyproject_path: Path to the pyproject.toml file.
+		pyproject_content: The content to write to the pyproject.toml file.
+	"""
+	with super_open(pyproject_path, "w") as file:
+		toml.dump(pyproject_content, file)
+
+def increment_version(version: str) -> str:
+	""" Increment the version.
+
+	Args:
+		version: The version to increment. (ex: "0.1.0")
+
+	Returns:
+		str: The incremented version. (ex: "0.1.1")
+	"""
+	version_parts: list[str] = version.split(".")
+	version_parts[-1] = str(int(version_parts[-1]) + 1)
+	return ".".join(version_parts)
+
+def increment_version_from_pyproject(pyproject_path: str) -> None:
+	""" Increment the version in the pyproject.toml file.
+
+	Args:
+		pyproject_path: Path to the pyproject.toml file.
+	"""
+	pyproject_content = read_pyproject(pyproject_path)
+	pyproject_content["project"]["version"] = increment_version(pyproject_content["project"]["version"])
+	write_pyproject(pyproject_path, pyproject_content)
+
+def get_version_from_pyproject(pyproject_path: str) -> str:
+	""" Get the version from the pyproject.toml file.
+
+	Args:
+		pyproject_path: Path to the pyproject.toml file.
+
+	Returns:
+		str: The version. (ex: "0.1.0")
+	"""
+	return read_pyproject(pyproject_path)["project"]["version"]
+

{stouputils-1.0.22 → stouputils-1.0.23}/src/stouputils/io.py

@@ -67,7 +67,7 @@ def clean_path(file_path: str) -> str:
 		'C:/folder1/folder2'
 	"""
 	# Replace tilde
-	file_path = replace_tilde(file_path)
+	file_path = replace_tilde(str(file_path))
 
 	# Check if original path ends with slash
 	ends_with_slash: bool = file_path.endswith('/') or file_path.endswith('\\')
@@ -85,6 +85,31 @@ def clean_path(file_path: str) -> str:
 	return file_path
 
 
+# Function that takes a relative path and returns the absolute path of the directory
+def get_root_path(relative_path: str, go_up: int = 0) -> str:
+	""" Get the absolute path of the directory. Usually used to get the root path of the project using the __file__ variable.
+
+	Args:
+		relative_path   (str): The path to get the absolute directory path from
+		go_up           (int): Number of parent directories to go up (default: 0)
+	Returns:
+		str: The absolute path of the directory
+
+	Examples:
+
+		.. code-block:: python
+
+			> get_root_path(__file__)
+			'C:/Users/Alexandre-PC/AppData/Local/Programs/Python/Python310/lib/site-packages/stouputils'
+
+			> get_root_path(__file__, 3)
+			'C:/Users/Alexandre-PC/AppData/Local/Programs/Python/Python310'
+	"""
+	return clean_path(
+		os.path.dirname(os.path.abspath(relative_path))
+		+ "/.." * go_up
+	)
+
 
 # For easy file management
 def super_open(file_path: str, mode: str, encoding: str = "utf-8") -> IO[Any]:

stouputils-1.0.23/upgrade.py

@@ -0,0 +1,16 @@
+
+## Python script that modifies the pyproject.toml to go to the next version
+# Imports
+import stouputils as stp
+
+# Constants
+ROOT: str = stp.get_root_path(__file__)
+PYPROJECT_PATH = f"{ROOT}/pyproject.toml"
+CURRENT_VERSION: str = stp.get_version_from_pyproject(PYPROJECT_PATH)
+
+# Main
+if __name__ == "__main__":
+	
+	# Increment version
+	stp.increment_version_from_pyproject(PYPROJECT_PATH)
+

stouputils-1.0.22/1_upgrades.py

@@ -1,4 +0,0 @@
-
-import os
-os.system("py -m pip install --upgrade pip setuptools build twine pkginfo")
-

stouputils-1.0.22/2_build.py

@@ -1,4 +0,0 @@
-
-import os
-os.system("py -m build")
-

stouputils-1.0.22/3_upload.py

@@ -1,10 +0,0 @@
-
-import os
-LAST_FILES: int = 1
-for root, _, files in os.walk("dist"):
-	files = sorted(files, key=lambda x: os.path.getmtime(f"dist/{x}"), reverse=True)
-	lasts = files[:LAST_FILES * 2] # x2 because we have the .tar.gz and the .whl
-	for file in lasts:
-		if file.endswith(".tar.gz"):
-			os.system(f"py -m twine upload --verbose -r stouputils dist/{file}")
-

stouputils-1.0.22/build_all_in_one.py

@@ -1,14 +0,0 @@
-
-import os
-import sys
-commands = [
-	f"{sys.executable} 1_upgrades.py",
-	f"{sys.executable} 2_build.py",
-	f"{sys.executable} 3_upload.py",
-]
-
-for command in commands:
-	if os.system(command) != 0:
-		print(f"Error while executing '{command}'")
-		exit(1)
-

stouputils-1.0.22/upgrade.py

@@ -1,58 +0,0 @@
-
-## Python script that modifies the pyproject.toml to go to the next version
-# Imports
-import os
-
-# Constants
-ROOT: str = os.path.dirname(os.path.realpath(__file__)).replace("\\", "/")
-PYPROJECT_PATH = f"{ROOT}/pyproject.toml"
-VERSION_KEY = "version = "
-
-def read_file(path: str) -> list[str]:
-	"""Read file and return lines"""
-	with open(path, "r", encoding="utf-8") as file:
-		return file.readlines()
-
-def find_version_line(lines: list[str]) -> int | None:
-	"""Find line containing version and return index"""
-	for i, line in enumerate(lines):
-		if line.startswith(VERSION_KEY):
-			return i
-	return None
-
-def increment_version(version: str) -> str:
-	"""Increment the last number in version string"""
-	parts = version.split(".")
-	parts[-1] = str(int(parts[-1]) + 1)
-	return ".".join(parts)
-
-def extract_version(line: str) -> str:
-	"""Extract version number from line"""
-	return line.replace(VERSION_KEY, "").strip().replace('"', "")
-
-def write_file(path: str, lines: list[str]) -> None:
-	"""Write lines to file"""
-	with open(path, "w", encoding="utf-8") as file:
-		file.writelines(lines)
-
-# Read the file
-lines = read_file(PYPROJECT_PATH)
-
-# Find and update version
-version_line = find_version_line(lines)
-current_version = None
-
-if version_line is not None:
-	# Get and increment version
-	current_version = extract_version(lines[version_line])
-	new_version = increment_version(current_version)
-
-	# Main
-	if __name__ == "__main__":
-		
-		# Update version line
-		lines[version_line] = f'{VERSION_KEY}"{new_version}"\n'
-		
-		# Write updated file
-		write_file(PYPROJECT_PATH, lines)
-