stouputils 1.0.24__tar.gz → 1.0.26__tar.gz

{stouputils-1.0.24 → stouputils-1.0.26}/PKG-INFO

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

{stouputils-1.0.24 → stouputils-1.0.26}/pyproject.toml

@@ -1,15 +1,25 @@
+
 [build-system]
-requires = [ "hatchling",]
+requires = ["hatchling"]
 build-backend = "hatchling.build"
 
 [project]
 name = "stouputils"
-version = "1.0.24"
+version = "1.0.26"
 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.0",
+	"requests>=2.30.0",
+	"pyyaml>=6.0.0",
+	"toml>=0.10.0",
+]
 [[project.authors]]
 name = "Stoupy51"
 email = "stoupy51@gmail.com"
@@ -20,3 +30,7 @@ Issues = "https://github.com/Stoupy51/stouputils/issues"
 
 [tool.pyright]
 typeCheckingMode = "strict"
+
+[tool.hatch.build]
+include = ["src"]
+

stouputils-1.0.26/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.24/.github/workflows/documentation.yml

@@ -1,42 +0,0 @@
-name: documentation
-
-on: 
-  push:
-    branches:
-      - main
-    tags:
-      - 'v*'
-  pull_request:
-  workflow_dispatch:
-
-permissions:
-  contents: write
-
-jobs:
-  docs:
-    runs-on: ubuntu-latest
-    steps:
-      - uses: actions/checkout@v4
-      - uses: actions/setup-python@v5
-      - name: Install dependencies
-        run: |
-          pip install hatch stouputils sphinx sphinx_rtd_theme myst_parser furo
-          hatch build
-      - name: Build latest docs
-        if: github.ref == 'refs/heads/main'
-        run: |
-          python scripts/create_docs.py
-      - name: Build version docs
-        if: startsWith(github.ref, 'refs/tags/v')
-        run: |
-          python scripts/create_docs.py ${GITHUB_REF#refs/tags/v}
-      - name: Deploy to GitHub Pages
-        uses: peaceiris/actions-gh-pages@v3
-        if: ${{ (github.event_name == 'push' && github.ref == 'refs/heads/main') || startsWith(github.ref, 'refs/tags/v') }}
-        with:
-          publish_branch: gh-pages
-          github_token: ${{ secrets.GITHUB_TOKEN }}
-          publish_dir: docs/build/html
-          keep_files: true
-          force_orphan: false
-

stouputils-1.0.24/.python-version

@@ -1 +0,0 @@
-3.10

stouputils-1.0.24/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.24/build_all_in_one.py

@@ -1,20 +0,0 @@
-
-# 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.24/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.24/examples/all_doctests.py

@@ -1,13 +0,0 @@
-
-# Imports
-import stouputils as stp
-
-# 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__":
-	main()
-

stouputils-1.0.24/examples/archive.py

@@ -1,24 +0,0 @@
-
-# Imports
-import stouputils as stp
-from zipfile import ZipFile, BadZipFile
-
-# Main
-if __name__ == "__main__":
-	PREFIX: str = "examples/archive"
-
-	## Repair a corrupted zip file
-	# Try to read the first file
-	@stp.handle_error(BadZipFile)
-	def read_file() -> None:
-		with ZipFile(f"{PREFIX}/corrupted.zip", "r") as zip_file:
-			stp.info(zip_file.read("pack.mcmeta"))
-	read_file()
-
-	# Repair it
-	stp.repair_zip_file(f"{PREFIX}/corrupted.zip", f"{PREFIX}/repaired.zip")
-
-	# Read the first file
-	with ZipFile(f"{PREFIX}/repaired.zip", "r") as zip_file:
-		stp.info(zip_file.read("pack.mcmeta"))
-

stouputils-1.0.24/examples/collections.py

@@ -1,28 +0,0 @@
-
-# Imports
-import stouputils as stp
-
-# Main
-if __name__ == "__main__":
-	
-	# Example with numbers
-	numbers: list[int] = [1, 2, 3, 2, 1, 4, 3]
-	unique_numbers: list[int] = stp.unique_list(numbers)
-	stp.info(f"Original numbers: {numbers}")
-	stp.info(f"Unique numbers: {unique_numbers}")
-	
-	# Example with sets using different methods
-	s1: set[int] = {1, 2, 3}
-	s2: set[int] = {2, 3, 4}
-	s3: set[int] = {1, 2, 3}
-	sets: list[set[int]] = [s1, s2, s1, s1, s3, s2, s3]
-	
-	# Using id method (keeps s1 and s3 as separate objects)
-	unique_sets_id: list[set[int]] = stp.unique_list(sets, method="id")
-	stp.info(f"Unique sets (id method): {unique_sets_id}")
-	
-	# Using str method (combines s1 and s3 as they have same string representation)
-	unique_sets_str: list[set[int]] = stp.unique_list(sets, method="str")
-	stp.info(f"Unique sets (str method): {unique_sets_str}")
-
-

stouputils-1.0.24/examples/ctx.py

@@ -1,25 +0,0 @@
-
-# Imports
-import stouputils as stp
-import sys
-import os
-
-# Main
-if __name__ == "__main__":
-	
-	with stp.Muffle(mute_stderr=True):
-		print("Nothing")
-		print("here", file=sys.stderr)
-		stp.info("will be")
-		stp.info("printed", file=sys.stderr)
-
-	OUTPUT_PATH: str = "_super_idol_de_xiao_rong.log"
-	with stp.LogToFile(OUTPUT_PATH):
-		stp.info("""
-Why did the programmer always bring a ladder to work?
-Because they spent so much time debugging and climbing through their log files!
-""")
-		
-	stp.breakpoint("Press Enter to continue...")
-	os.remove(OUTPUT_PATH)
-

stouputils-1.0.24/examples/decorators_1.py

@@ -1,29 +0,0 @@
-
-# Imports
-import stouputils as stp
-import time
-
-# Main
-if __name__ == "__main__":
-	
-	# Cache the result of the function and measure the time it takes to execute
-	@stp.measure_time(stp.progress, "Time taken to execute long_function")
-	@stp.simple_cache()
-	def long_function() -> dict[str, int]:
-		stp.info("Starting long function...")
-		time.sleep(1)
-		stp.info("Long function finished!")
-		return {"a": 1, "b": 2}
-	
-	a = long_function()		# Takes 1 second
-	b = long_function()		# Takes 0 second
-	stp.info(f"a: {a}, b: {b}, a is b: {a is b}")
-	b["c"] = 3
-	stp.info(f"a has been modified because a is b: {a}")
-
-	# Silent decorator
-	@stp.silent
-	def silent_function():
-		print("ON THE CONSOLE")
-	silent_function()
-

stouputils-1.0.24/examples/decorators_2.py

@@ -1,21 +0,0 @@
-
-# Imports
-import stouputils as stp
-
-# Main
-if __name__ == "__main__":
-
-	# Handle exceptions
-	@stp.handle_error(ZeroDivisionError,
-		"Debugging: The process of removing software bugs, and putting in new ones",
-		error_log=stp.LogLevels.WARNING_TRACEBACK
-	)
-	def raise_value_error():
-		return 1 / 0
-
-	@stp.handle_error()
-	def raise_value_error_2():
-		return 1 / 0
-
-	raise_value_error()			# This will show the error using stp.warning
-	raise_value_error_2()		# This will show the error using stp.error

stouputils-1.0.24/examples/delta_backup.py

@@ -1,7 +0,0 @@
-
-# Example of use:
-# py examples/delta_backup.py delta "src" "backup" -x "*pycache*"
-
-import stouputils as stp
-stp.backup_cli()
-

stouputils-1.0.24/examples/io.py

@@ -1,33 +0,0 @@
-
-# Imports
-import stouputils as stp
-from typing import Any
-
-# Main
-if __name__ == "__main__":
-	
-	path: str = "C:\\\\Users\\\\Stoupy\\\\Documents\\\\test.txt"
-	path = stp.clean_path(path)
-	stp.info(path)
-
-	tilde_path: str = "~/Desktop/OnlyFansIncome.txt"
-	tilde_path = stp.replace_tilde(tilde_path)
-	stp.info(tilde_path)
-
-	this_folder_dont_exist: str = "./this_folder_dont_exist/a/c/feff/efefe/a"
-	with stp.super_open(this_folder_dont_exist, "w") as file:	# Automatically create the folder
-		file.write("Hello, world!")
-	
-	# Copy a file to a folder, or rename the copied file
-	stp.super_copy("LICENSE", "this_folder_dont_exist/a/")           # .../a/LICENSE
-	stp.super_copy("LICENSE", "this_folder_dont_exist/a/LICENSE_2")  # .../a/LICENSE_2
-	stp.breakpoint("Waiting for input to continue code execution...")
-
-	# Dump a JSON file with a specified indentation depth
-	data: dict[str, Any] = {"name": "John", "array": [[[1, 2, 3], [4, 5, 6]], [[7, 8, 9], [10, 11, 12]]]}
-	stp.info("\n", stp.super_json_dump(data, max_level=2))
-
-	# Remove the folder
-	import shutil
-	shutil.rmtree("this_folder_dont_exist")
-

stouputils-1.0.24/examples/parallel.py

@@ -1,28 +0,0 @@
-
-# Imports
-import stouputils as stp
-import time
-
-# Functions
-def is_even(n: int) -> bool:
-	return n % 2 == 0
-
-def multiple_args(a: int, b: int) -> int:
-	return a * b
-
-# Main
-if __name__ == "__main__":
-	
-	# Multi-threading (blazingly fast for IO-bound tasks)
-	args_1: list[int] = [1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
-	results_1: list[bool] = stp.multithreading(is_even, args_1)
-	stp.info(f"Results: {results_1}")
-
-	# Multi-processing (better for CPU-bound tasks)
-	time.sleep(1)
-	args_2: list[tuple[int, int]] = [(1, 2), (3, 4), (5, 6), (7, 8), (9, 10)]
-	results_2: list[int] = stp.multiprocessing(
-		multiple_args, args_2, use_starmap=True, desc="Multiple args", max_workers=2, verbose=1
-	)
-	stp.info(f"Results: {results_2}")
-

stouputils-1.0.24/examples/print.py

@@ -1,27 +0,0 @@
-
-# Imports
-import time
-import stouputils as stp
-
-# Main
-if __name__ == "__main__":
-	stp.info("Hello", "World")
-	time.sleep(0.5)
-	stp.info("Hello", "World")
-	time.sleep(0.5)
-	stp.info("Hello", "World")
-	time.sleep(0.5)
-	stp.info("Not Hello World !")
-	time.sleep(0.5)
-	stp.info("Hello", "World")
-	time.sleep(0.5)
-	stp.info("Hello", "World")
-
-	# All remaining print functions
-	stp.debug("Hello", "World")
-	stp.suggestion("Hello", "World")
-	stp.progress("Hello", "World")
-	stp.warning("Hello", "World")
-	stp.error("Hello", "World", exit=False)
-	stp.whatisit("Hello", "World")
-

stouputils-1.0.24/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.24/scripts/create_docs.py

@@ -1,315 +0,0 @@
-
-# Imports
-import os
-import shutil
-import subprocess
-import sys
-from stouputils import clean_path, handle_error, warning, simple_cache
-from stouputils.continuous_delivery.github import version_to_float
-clean_exec: str = clean_path(sys.executable)
-
-conf_content: str = """
-# Imports
-import os
-import sys
-from typing import Any
-sys.path.insert(0, os.path.abspath('../..'))
-sys.path.insert(0, os.path.abspath('../../src'))
-from upgrade import current_version		# Get version from pyproject.toml
-
-# Project information
-project: str = 'stouputils'
-copyright: str = '2024, Stoupy'
-author: str = 'Stoupy'
-release: str = current_version
-
-# General configuration
-extensions: list[str] = [
-	'sphinx.ext.autodoc',
-	'sphinx.ext.napoleon',
-	'sphinx.ext.viewcode', 
-	'sphinx.ext.githubpages',
-	'sphinx.ext.intersphinx',
-	'furo.sphinxext',
-]
-
-templates_path: list[str] = ['_templates']
-exclude_patterns: list[str] = []
-
-# HTML output options
-html_theme: str = 'furo'
-html_static_path: list[str] = ['_static']
-html_logo: str = 'https://avatars.githubusercontent.com/u/35665974'
-html_title: str = 'stouputils'
-html_favicon: str = 'https://avatars.githubusercontent.com/u/35665974'
-
-# Theme options
-html_theme_options: dict[str, Any] = {
-	'light_css_variables': {
-		'color-brand-primary': '#2980B9',
-		'color-brand-content': '#2980B9',
-		'color-admonition-background': '#E8F0F8',
-	},
-	'dark_css_variables': {
-		'color-brand-primary': '#56B4E9',
-		'color-brand-content': '#56B4E9',
-		'color-admonition-background': '#1F262B',
-	},
-	'sidebar_hide_name': False,
-	'navigation_with_keys': True,
-	'announcement': 'This is the latest documentation of stouputils',
-	'footer_icons': [
-		{
-			'name': 'GitHub',
-			'url': 'https://github.com/Stoupy51/stouputils',
-			'html': '<i class="fab fa-github-square"></i>',
-			'class': '',
-		},
-	],
-}
-
-# Add any paths that contain custom static files
-html_static_path: list[str] = ['_static']
-
-# Autodoc settings
-autodoc_default_options: dict[str, bool | str] = {
-	'members': True,
-	'member-order': 'bysource',
-	'special-members': False,
-	'undoc-members': False,
-	'private-members': False,
-	'show-inheritance': True,
-	'ignore-module-all': True,
-	'exclude-members': '__weakref__'
-}
-
-# Tell autodoc to prefer source code over installed package
-autodoc_mock_imports = []
-always_document_param_types = True
-add_module_names = False
-
-# Tell Sphinx to look for source code in src directory
-html_context = {
-	'display_github': True,
-	'github_user': 'Stoupy51',
-	'github_repo': 'stouputils',
-	'github_version': 'main',
-	'conf_py_path': '/docs/source/',
-	'source_suffix': '.rst',
-	'default_mode': 'dark',
-}
-
-# Only document items with docstrings
-def skip_undocumented(app: Any, what: str, name: str, obj: Any, skip: bool, *args: Any, **kwargs: Any) -> bool:
-	if not obj.__doc__:
-		return True
-	return skip
-
-def setup(app: Any) -> None:
-	app.connect('autodoc-skip-member', skip_undocumented)
-"""
-
-@simple_cache()
-def get_versions_from_github() -> list[str]:
-	""" Get list of versions from GitHub gh-pages branch.
-
-	Returns:
-		list[str]: List of versions, with 'latest' as first element
-	"""
-	import requests
-	version_list: list[str] = []
-	try:
-		response = requests.get("https://api.github.com/repos/Stoupy51/stouputils/contents?ref=gh-pages")
-		if response.status_code == 200:
-			contents = response.json()
-			version_list = ["latest"] + sorted(
-				[d["name"].replace("v", "") for d in contents 
-				if d["type"] == "dir" and d["name"].startswith("v")],
-				key=version_to_float,
-				reverse=True
-			)
-	except Exception as e:
-		warning(f"Failed to get versions from GitHub: {e}")
-		version_list = ["latest"]
-	return version_list
-
-def generate_index_rst(readme_path: str, index_path: str) -> None:
-	""" Generate index.rst from README.md content.
-	
-	Args:
-		readme_path (str): Path to the README.md file
-		index_path (str): Path where index.rst should be created
-	"""
-	with open(readme_path, 'r', encoding="utf-8") as f:
-		readme_content: str = f.read()
-	
-	# Convert markdown badges to RST format
-	badges_rst: str = """
-.. image:: https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=github&label=GitHub
-  :target: https://github.com/Stoupy51/stouputils/releases/latest
-
-.. image:: https://img.shields.io/pypi/dm/stouputils?logo=python&label=PyPI%20downloads
-  :target: https://pypi.org/project/stouputils/
-"""
-	
-	# Generate version selector
-	version_selector: str = """
-
-**Versions**: """
-	
-	# Get versions from GitHub
-	version_list: list[str] = get_versions_from_github()
-	
-	# Create version links
-	version_links: list[str] = []
-	for version in version_list:
-		if version == 'latest':
-			version_links.append("`latest <../latest/index.html>`_")
-		else:
-			version_links.append(f"`v{version} <../v{version}/index.html>`_")
-	
-	version_selector += ", ".join(version_links)
-	
-	# Extract sections while preserving emojis
-	overview_section: str = readme_content.split('# 📚 Project Overview')[1].split('\n#')[0].strip()
-	file_tree_section: str = readme_content.split('# 🚀 Project File Tree')[1].split('\n#')[0].strip()
-	file_tree_section = file_tree_section.replace('```bash', '').replace('```', '').strip()
-	file_tree_section = "\n".join([f"   {line}" for line in file_tree_section.split('\n')])
-	
-	# Generate module documentation section
-	module_docs: str = ".. toctree::\n   :maxdepth: 10\n   :caption: Contents:\n\n"
-	
-	# Add base module
-	module_docs += "   modules/stouputils\n\n"
-	
-	# Generate the RST content with emojis and proper title underlines
-	rst_content: str = f"""
-🛠️ Welcome to Stouputils Documentation
-=======================================
-
-{badges_rst}
-
-{version_selector}
-
-📚 Overview
------------
-{overview_section.replace("<br>", " ")}
-
-🚀 Project Structure
--------------------
-.. code-block:: bash
-
-{file_tree_section}
-
-📖 Module Documentation
-----------------------
-{module_docs}
-
-⚡ Indices and Tables
-===================
-
-* :ref:`genindex`
-* :ref:`modindex`
-* :ref:`search`
-"""
-	
-	# Write the RST file
-	with open(index_path, 'w', encoding="utf-8") as f:
-		f.write(rst_content)
-
-def generate_conf_py(conf_path: str) -> None:
-	""" Generate conf.py file.
-	
-	Args:
-		conf_path (str): Path where conf.py should be created
-	"""
-	with open(conf_path, 'w', encoding="utf-8") as f:
-		f.write(conf_content)
-
-@handle_error()
-def update_documentation(version: str | None = None) -> None:
-	""" Update the Sphinx documentation.
-	This script will:
-	1. Create necessary directories if they don't exist
-	2. Generate module documentation using sphinx-apidoc
-	3. Build HTML documentation for specific version if provided
-
-	Args:
-		version (str | None): Version to build documentation for. If None, builds for latest
-	"""
-	# Get the project root directory (parent of scripts folder)
-	root_dir: str = clean_path(os.path.dirname(os.path.dirname(__file__)))
-	docs_dir: str = clean_path(os.path.join(root_dir, "docs"))
-	source_dir: str = clean_path(os.path.join(docs_dir, "source"))
-	modules_dir: str = clean_path(os.path.join(source_dir, "modules"))
-
-	# Modify build directory if version is specified
-	build_dir: str = "html/latest" if not version else f"html/v{version}"
-	
-	# Create directories if they don't exist
-	os.makedirs(modules_dir, exist_ok=True)
-	os.makedirs(clean_path(os.path.join(source_dir, "_static")), exist_ok=True)
-	os.makedirs(clean_path(os.path.join(source_dir, "_templates")), exist_ok=True)
-
-	# Generate index.rst from README.md
-	readme_path: str = clean_path(os.path.join(root_dir, "README.md"))
-	index_path: str = clean_path(os.path.join(source_dir, "index.rst"))
-	generate_index_rst(readme_path, index_path)
-
-	# Clean up old module documentation
-	if os.path.exists(modules_dir):
-		shutil.rmtree(modules_dir)
-		os.makedirs(modules_dir)
-
-	# Update conf.py to include version selector
-	version_list: list[str] = get_versions_from_github()
-	
-	# Update html_context in conf.py
-	global conf_content
-	conf_content = conf_content.replace(
-		"html_context = {",
-		f"""html_context = {{
-	'versions': {version_list},
-	'current_version': 'latest' if not {repr(version)} else {repr(version)},"""
-	)
-
-	# Generate docs/source/conf.py
-	conf_path: str = clean_path(os.path.join(source_dir, "conf.py"))
-	generate_conf_py(conf_path)
-
-	# Generate module documentation using python -m
-	subprocess.run([
-		clean_exec,
-		"-m", "sphinx.ext.apidoc",
-		"-o", modules_dir,      # Output directory
-		"-f",                   # Force overwrite
-		"-e",                   # Put documentation for each module on its own page
-		"-M",                   # Put module documentation before submodule documentation
-		"--no-toc",             # Don't create a table of contents file
-		"-P",                   # Include private modules
-		"--implicit-namespaces",# Handle implicit namespaces
-		"--module-first",       # Put module documentation before submodule documentation
-		clean_path(os.path.join(root_dir, "src/stouputils")),  # Source code directory
-	], check=True)
-
-	# Build HTML documentation using python -m
-	subprocess.run([
-		clean_exec,
-		"-m", "sphinx",
-		"-b", "html",           # Build HTML
-		"-a",                   # Write all files
-		source_dir,             # Source directory
-		clean_path(f"{docs_dir}/build/{build_dir}"),  # Output directory
-	], check=True)
-
-	print("Documentation updated successfully!")
-	print(f"You can view the documentation by opening {docs_dir}/build/{build_dir}/index.html")
-
-if __name__ == "__main__":
-	if len(sys.argv) == 2:
-		update_documentation(sys.argv[1].replace("v", ""))	# Remove "v" from version just in case
-	elif len(sys.argv) == 1:
-		update_documentation()
-	else:
-		raise ValueError("Usage: python create_docs.py [version]")
-

stouputils-1.0.24/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.24/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)
-