stouputils 1.0.23__tar.gz → 1.0.25__tar.gz

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

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: stouputils
-Version: 1.0.23
+Version: 1.0.25
 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.0.25/copy_in_local.py

@@ -0,0 +1,22 @@
+
+# Imports
+import stouputils as stp
+import shutil
+
+# Constants
+ROOT: str = stp.get_root_path(__file__)
+SOURCE: str = f"{ROOT}/src/stouputils"
+DESTINATION: str = "C:/Users/Alexandre-PC/AppData/Local/Programs/Python/Python310/Lib/site-packages/stouputils"
+
+# Main
+if __name__ == "__main__":
+
+	# Remove destination
+	shutil.rmtree(DESTINATION, ignore_errors=True)
+
+	# Copy source
+	shutil.copytree(SOURCE, DESTINATION)
+
+	# Info
+	stp.info("Copied stouputils to local Python's site-packages")
+

stouputils-1.0.25/full_routine.py

@@ -0,0 +1,18 @@
+
+# Imports
+import os
+import sys
+import stouputils as stp
+
+# Constants
+ROOT: str = stp.get_root_path(__file__)
+
+# Main
+if __name__ == "__main__":
+
+	# Increment version in pyproject.toml
+	stp.increment_version_from_pyproject(f"{ROOT}/pyproject.toml")
+
+	# PyPI full routine
+	os.system(f"{sys.executable} {ROOT}/scripts/pypi_full_routine.py")
+

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

@@ -1,15 +1,25 @@
+
 [build-system]
-requires = [ "hatchling",]
+requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.0.23"
+version = "1.0.25"
 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", "toml",]
+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"
@@ -20,3 +30,4 @@ Issues = "https://github.com/Stoupy51/stouputils/issues"
 
 [tool.pyright]
 typeCheckingMode = "strict"
+

stouputils-1.0.25/scripts/github_release.py

@@ -0,0 +1,28 @@
+
+# Imports
+import stouputils as stp
+from typing import Any
+
+# Constants
+ROOT: str = stp.get_root_path(__file__, go_up=1)
+CURRENT_VERSION: str = stp.get_version_from_pyproject(f"{ROOT}/pyproject.toml")
+CREDENTIALS_PATH: str = "~/stouputils/credentials.yml"
+GITHUB_CONFIG: dict[str, Any] = {
+	"project_name": "stouputils",
+	"version": CURRENT_VERSION,
+	"build_folder": f"{ROOT}/dist",
+	"endswith": [
+		f"{CURRENT_VERSION}.tar.gz",
+		f"{CURRENT_VERSION}-py3-none-any.whl",
+	],
+}
+
+# Main
+if __name__ == "__main__":
+
+	# Get credentials
+	credentials: dict[str, Any] = stp.load_credentials(CREDENTIALS_PATH)
+
+	# Upload to GitHub
+	changelog: str = stp.upload_to_github(credentials, GITHUB_CONFIG)
+

stouputils-1.0.23/build_all_in_one.py → stouputils-1.0.25/scripts/pypi_full_routine.py

@@ -3,7 +3,7 @@
 import stouputils as stp
 
 # Constants
-ROOT: str = stp.get_root_path(__file__)
+ROOT: str = stp.get_root_path(__file__, go_up=1)
 REPOSITORY: str = "stouputils"
 DIST_DIRECTORY: str = f"{ROOT}/dist"
 LAST_FILES: int = 1

stouputils-1.0.25/scripts/upgrade.py

@@ -0,0 +1,11 @@
+
+# Imports
+import stouputils as stp
+
+# Main
+if __name__ == "__main__":
+	
+	# Increment version
+	ROOT: str = stp.get_root_path(__file__, go_up=1)
+	stp.increment_version_from_pyproject(f"{ROOT}/pyproject.toml")
+

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

@@ -0,0 +1,121 @@
+""" Utilities for reading, writing and managing pyproject.toml files.
+
+This module provides functions to handle pyproject.toml files, including reading,
+writing, version management and TOML formatting capabilities.
+
+- read_pyproject: Read the pyproject.toml file.
+- write_pyproject: Write to the pyproject.toml file.
+- format_toml_lists: Format TOML lists with proper indentation.
+- increment_version_from_input: Increment the patch version number.
+- increment_version_from_pyproject: Increment version in pyproject.toml.
+- get_version_from_pyproject: Get version from pyproject.toml.
+
+.. 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 format_toml_lists(content: str) -> str:
+	""" Format TOML lists with indentation.
+
+	Args:
+		content (str): The content of the pyproject.toml file.
+
+	Returns:
+		str: The formatted content with properly indented lists.
+	"""
+	# Split the content into individual lines for processing
+	lines: list[str] = content.split("\n")
+	formatted_lines: list[str] = []
+
+	for line in lines:
+		# Check if line contains a list definition (has both [ ] and = characters)
+		if "[" in line and "]" in line and "=" in line:
+			# Only process simple lists that have one opening and closing bracket
+			if line.count("[") == 1 and line.count("]") == 1:
+				# Split into key and values parts
+				key, values = line.split("=", 1)
+				values = values.strip()
+				
+				# Check if values portion is a list
+				if values.startswith("[") and values.endswith("]"):
+					# Parse list values, removing empty entries
+					values = [v.strip() for v in values[1:-1].split(",") if v.strip()]
+					
+					# For lists with multiple items, format across multiple lines
+					if len(values) > 1:
+						formatted_lines.append(f"{key}= [")
+						for value in values:
+							formatted_lines.append(f"\t{value},")
+						formatted_lines.append("]")
+					# For single item lists, keep on one line
+					else:
+						formatted_lines.append(f"{key}= [{values[0]}]")
+					continue
+
+		# Keep non-list lines unchanged
+		formatted_lines.append(line)
+
+	# Rejoin all lines with newlines
+	return "\n".join(formatted_lines)
+
+
+def write_pyproject(pyproject_path: str, pyproject_content: dict[str, Any]) -> None:
+	""" Write to the pyproject.toml file with properly indented lists. """
+	content: str = "\n" + toml.dumps(pyproject_content) + "\n"
+	content = format_toml_lists(content)  # Apply formatting
+
+	with super_open(pyproject_path, "w") as file:
+		file.write(content)
+
+
+def increment_version_from_input(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: dict[str, Any] = read_pyproject(pyproject_path)
+	pyproject_content["project"]["version"] = increment_version_from_input(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.23/all_in_one.py

@@ -1,13 +0,0 @@
-
-import os
-import sys
-commands = [
-	f"{sys.executable} upgrade.py",				# Upgrade the version in pyproject.toml
-	f"{sys.executable} build_all_in_one.py",	# Build the package and upload it
-]
-
-for command in commands:
-	if os.system(command) != 0:
-		print(f"Error while executing '{command}'")
-		exit(1)
-

stouputils-1.0.23/copy_in_local.py

@@ -1,12 +0,0 @@
-
-import shutil
-import os
-
-source = os.path.dirname(os.path.realpath(__file__)).replace("\\","/") + "/src/stouputils"
-destination = "C:/Users/Alexandre-PC/AppData/Local/Programs/Python/Python310/Lib/site-packages/stouputils"
-
-shutil.rmtree(destination, ignore_errors=True)
-shutil.copytree(source, destination)
-os.system("clear")
-print("\nCopied stouputils to local Python's site-packages\n")
-

stouputils-1.0.23/github_release.py

@@ -1,26 +0,0 @@
-
-# Imports
-from stouputils import load_credentials, upload_to_github, clean_path
-from typing import Any
-from upgrade import current_version
-import os
-
-# Constants
-ROOT: str = clean_path(os.path.dirname(os.path.abspath(__file__)))
-CREDENTIALS_PATH: str = "~/stouputils/credentials.yml"
-GITHUB_CONFIG: dict[str, Any] = {
-	"project_name": "stouputils",
-	"version": current_version,
-	"build_folder": f"{ROOT}/dist",
-	"endswith": [
-		f"{current_version}.tar.gz",
-		f"{current_version}-py3-none-any.whl",
-	],
-}
-
-# Get credentials
-credentials: dict[str, Any] = load_credentials(CREDENTIALS_PATH)
-
-# Upload to GitHub
-changelog: str = upload_to_github(credentials, GITHUB_CONFIG)
-

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

@@ -1,69 +0,0 @@
-""" 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.23/upgrade.py

@@ -1,16 +0,0 @@
-
-## 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)
-