PyPI - stouputils - Versions diffs - 1.2.0__tar.gz → 1.2.2__tar.gz - Mend

stouputils 1.2.0tar.gz → 1.2.2tar.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 (28) hide show

stouputils-1.2.2/PKG-INFO ADDED Viewed

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: stouputils
+Version: 1.2.2
+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
+Author-email: Stoupy51 <stoupy51@gmail.com>
+License-File: LICENSE
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3
+Requires-Python: >=3.10
+Requires-Dist: m2r2>=0.3.3.post2
+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
+# 🛠️ Project Badges
+[![GitHub](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=github&label=GitHub)](https://github.com/Stoupy51/stouputils/releases/latest)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/stouputils?logo=python&label=PyPI%20downloads)](https://pypi.org/project/stouputils/)
+[![Documentation](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=sphinx&label=Documentation&color=purple)](https://stoupy51.github.io/stouputils/latest/)
+# 📚 Project Overview
+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.
+# 🚀 Project File Tree
+```bash
+stouputils/
+├── applications/
+│   ├── automatic_docs.py    # 📚 Documentation generation utilities (used to create this documentation)
+│   └── ...
+│
+├── continuous_delivery/
+│   ├── cd_utils.py          # 🔧 Common utilities for continuous delivery
+│   ├── github.py            # 📦 GitHub utilities (upload_to_github)
+│   ├── pypi.py              # 📦 PyPI utilities (pypi_full_routine)
+│   ├── pyproject.py         # 📝 Pyproject.toml utilities
+│   └── ...
+│
+├── print.py                 # 🖨️ Display utilities (info, debug, warning, error)
+├── io.py                    # 💻 I/O utilities (file management, json)
+├── decorators.py            # 🎯 Decorators (silent, measure_time, error_handler, simple_cache)
+├── ctx.py                   # 🚫 Context managers (Muffle, LogToFile)
+├── archive.py               # 📦 Archive utilities (zip, repair_zip)
+├── parallel.py              # 🧑‍🤝‍🧑 Parallel processing (multiprocessing, multithreading)
+├── collections.py           # 🧰 Collection utilities (unique_list)
+├── all_doctests.py          # ✅ Execution of all doctests for a given path
+├── backup.py                # 📦 Backup utilities (delta backup, consolidate)
+└── ...
+```
+## ⭐ Star History
+<html>
+  <a href="https://star-history.com/#Stoupy51/stouputils&Date">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date&theme=dark" />
+      <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
+      <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
+    </picture>
+  </a>
+</html>

stouputils-1.2.2/README.md ADDED Viewed

@@ -0,0 +1,51 @@
+# 🛠️ Project Badges
+[![GitHub](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=github&label=GitHub)](https://github.com/Stoupy51/stouputils/releases/latest)
+[![PyPI - Downloads](https://img.shields.io/pypi/dm/stouputils?logo=python&label=PyPI%20downloads)](https://pypi.org/project/stouputils/)
+[![Documentation](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=sphinx&label=Documentation&color=purple)](https://stoupy51.github.io/stouputils/latest/)
+# 📚 Project Overview
+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.
+# 🚀 Project File Tree
+```bash
+stouputils/
+├── applications/
+│   ├── automatic_docs.py    # 📚 Documentation generation utilities (used to create this documentation)
+│   └── ...
+│
+├── continuous_delivery/
+│   ├── cd_utils.py          # 🔧 Common utilities for continuous delivery
+│   ├── github.py            # 📦 GitHub utilities (upload_to_github)
+│   ├── pypi.py              # 📦 PyPI utilities (pypi_full_routine)
+│   ├── pyproject.py         # 📝 Pyproject.toml utilities
+│   └── ...
+│
+├── print.py                 # 🖨️ Display utilities (info, debug, warning, error)
+├── io.py                    # 💻 I/O utilities (file management, json)
+├── decorators.py            # 🎯 Decorators (silent, measure_time, error_handler, simple_cache)
+├── ctx.py                   # 🚫 Context managers (Muffle, LogToFile)
+├── archive.py               # 📦 Archive utilities (zip, repair_zip)
+├── parallel.py              # 🧑‍🤝‍🧑 Parallel processing (multiprocessing, multithreading)
+├── collections.py           # 🧰 Collection utilities (unique_list)
+├── all_doctests.py          # ✅ Execution of all doctests for a given path
+├── backup.py                # 📦 Backup utilities (delta backup, consolidate)
+└── ...
+```
+## ⭐ Star History
+<html>
+  <a href="https://star-history.com/#Stoupy51/stouputils&Date">
+    <picture>
+      <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date&theme=dark" />
+      <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
+      <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
+    </picture>
+  </a>
+</html>

{stouputils-1.2.0 → stouputils-1.2.2}/pyproject.toml RENAMED Viewed

@@ -5,7 +5,7 @@ build-backend = "hatchling.build"
 [project]
 name = "stouputils"
-version = "1.2.0"
+version = "1.2.2"
 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"
@@ -19,6 +19,7 @@ dependencies = [
 	"requests>=2.30.0",
 	"pyyaml>=6.0.0",
 	"toml>=0.10.0",
+	"m2r2>=0.3.3.post2",
 ]
 [[project.authors]]
 name = "Stoupy51"

stouputils-1.2.2/stouputils/__init__.py ADDED Viewed

@@ -0,0 +1,31 @@
+""" A collection of utility modules designed to simplify and enhance the development process.
+This package provides various tools and utilities for common development tasks including:
+Key Features:
+- Continuous delivery utilities (GitHub, PyPI)
+- Display and logging utilities (print)
+- File and I/O management (io)
+- Decorators for common patterns
+- Context managers
+- Archive and backup tools
+- Parallel processing helpers
+- Collection utilities
+- Doctests utilities
+"""
+# Imports
+from .print import *
+from .archive import *
+from .io import *
+from .decorators import *
+from .ctx import *
+from .parallel import *
+from .all_doctests import *
+from .collections import *
+from .backup import *
+# Folders
+from .continuous_delivery import *

stouputils-1.2.2/stouputils/applications/__init__.py ADDED Viewed

@@ -0,0 +1,15 @@
+""" Application-specific utilities and tools.
+This module provides higher-level utilities for specific application needs:
+Key Features:
+- Automatic documentation generation with Sphinx: `update_documentation(...)`
+- Support for multi-version documentation
+- GitHub Pages integration
+- Markdown to RST conversion
+"""
+# Imports
+from .automatic_docs import *

stouputils-1.2.2/stouputils/applications/automatic_docs.py ADDED Viewed

@@ -0,0 +1,507 @@
+""" Sphinx documentation generation utilities.
+This module provides a comprehensive set of utilities for automatically generating
+and managing Sphinx documentation for Python projects. It handles the creation
+of configuration files, index pages, version management, and HTML generation.
+Example of usage:
+.. code-block:: python
+    import stouputils as stp
+    from stouputils.applications import automatic_docs
+    if __name__ == "__main__":
+        automatic_docs.update_documentation(
+            root_path=stp.get_root_path(__file__, go_up=1),
+            project="stouputils",
+            author="Stoupy",
+            copyright="2025, Stoupy",
+            html_logo="https://avatars.githubusercontent.com/u/35665974",
+            html_favicon="https://avatars.githubusercontent.com/u/35665974",
+            github_user="Stoupy51",
+            github_repo="stouputils",
+            version="1.2.0",
+            skip_undocumented=True,
+        )
+.. image:: https://raw.githubusercontent.com/Stoupy51/stouputils/refs/heads/main/assets/applications/automatic_docs.gif
+  :alt: stouputils automatic_docs examples
+Note:
+    This module requires Sphinx and its dependencies to be installed.
+    It also requires the 'm2r2' package for Markdown to RST conversion.
+Example of GitHub Actions workflow:
+.. code-block:: yaml
+  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 m2r2
+            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
+"""
+# Imports
+import os
+import shutil
+import subprocess
+import sys
+from typing import Any, Callable
+from ..io import clean_path, super_open, super_json_dump
+from ..decorators import handle_error, simple_cache
+from ..continuous_delivery import version_to_float
+from ..print import info
+def get_sphinx_conf_content(
+	project: str,
+	author: str,
+	current_version: str,
+	copyright: str,
+	html_logo: str,
+	html_favicon: str,
+	github_user: str,
+	github_repo: str,
+	version_list: list[str] | None = None,
+	skip_undocumented: bool = True,
+) -> str:
+	""" Get the content of the Sphinx configuration file.
+	Args:
+		project           (str):              Name of the project
+		author            (str):              Author of the project
+		current_version   (str):              Current version
+		copyright         (str):              Copyright information
+		html_logo         (str):              URL to the logo
+		html_favicon      (str):              URL to the favicon
+		github_user       (str):              GitHub username
+		github_repo       (str):              GitHub repository name
+		version_list      (list[str] | None): List of versions. Defaults to None
+		skip_undocumented (bool):             Whether to skip undocumented members. Defaults to True
+	Returns:
+		str: Content of the Sphinx configuration file
+	"""
+	conf_content: str = f"""
+# Imports
+import os
+import sys
+from typing import Any
+# Project information
+project: str = "{project}"
+copyright: str = "{copyright}"
+author: str = "{author}"
+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",
+	"m2r2",
+]
+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 = "{html_logo}"
+html_title: str = "{project}"
+html_favicon: str = "{html_favicon}"
+# 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 {project}",
+	"footer_icons": [
+		{{
+			"name": "GitHub",
+			"url": "https://github.com/{github_user}/{github_repo}",
+			"html": "<i class='fab fa-github-square'></i>",
+			"class": "",
+		}},
+	],
+}}
+"""
+	# Create base html_context dictionary
+	html_context: dict[str, Any] = {
+		"display_github": True,
+		"github_user": github_user,
+		"github_repo": github_repo,
+		"github_version": "main",
+		"conf_py_path": "/docs/source/",
+		"source_suffix": [".rst", ".md"],
+		"default_mode": "dark",
+	}
+	# Add version selector if versions are provided
+	if version_list and current_version:
+		html_context.update({
+			"versions": version_list,
+			"current_version": current_version,
+		})
+	html_context_str: str = super_json_dump(html_context, max_level=1).replace("true", "True").replace("false", "False")
+	conf_content += f"""
+html_context = {html_context_str}
+# 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
+"""
+	if skip_undocumented:
+		conf_content += """
+# 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)
+"""
+	return conf_content
+@simple_cache()
+def get_versions_from_github(github_user: str, github_repo: str) -> list[str]:
+	""" Get list of versions from GitHub gh-pages branch.
+	Args:
+		github_user    (str): GitHub username
+		github_repo    (str): GitHub repository name
+	Returns:
+		list[str]: List of versions, with 'latest' as first element
+	"""
+	import requests
+	version_list: list[str] = []
+	try:
+		response = requests.get(f"https://api.github.com/repos/{github_user}/{github_repo}/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:
+		info(f"Failed to get versions from GitHub: {e}")
+		version_list = ["latest"]
+	return version_list
+def markdown_to_rst(markdown_content: str) -> str:
+	""" Convert markdown content to RST format.
+	Args:
+		markdown_content (str): Markdown content
+	Returns:
+		str: RST content
+	"""
+	if not markdown_content:
+		return ""
+	# Convert markdown to RST and return it
+	import m2r2		# type: ignore
+	return m2r2.convert(markdown_content)	# type: ignore
+def generate_index_rst(
+	readme_path: str,
+	index_path: str,
+	project: str,
+	github_user: str,
+	github_repo: str,
+	get_versions_function: Callable[[str, str], list[str]] = get_versions_from_github,
+) -> 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
+		project                (str): Name of the project
+		github_user            (str): GitHub username
+		github_repo            (str): GitHub repository name
+		get_versions_function  (Callable[[str, str], list[str]]): Function to get versions from GitHub
+	"""
+	# Read README content
+	with open(readme_path, "r", encoding="utf-8") as f:
+		readme_content: str = f.read()
+	# Generate version selector
+	version_selector: str = "\n\n**Versions**: "
+	# Get versions from GitHub
+	version_list: list[str] = get_versions_function(github_user, github_repo)
+	# 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)
+	# Generate module documentation section
+	module_docs: str = f"""
+.. toctree::
+   :maxdepth: 10
+   modules/{project}
+"""
+	# Convert markdown to RST
+	rst_content: str = f"""
+🛠️ Welcome to {project.capitalize()} Documentation
+{'=' * 100}
+{version_selector}
+{markdown_to_rst(readme_content)}
+📖 Module Documentation
+{'-' * 100}
+{module_docs}
+"""
+	# Write the RST file
+	with open(index_path, "w", encoding="utf-8") as f:
+		f.write(rst_content)
+def generate_documentation(
+	source_dir: str,
+	modules_dir: str,
+	project_dir: str,
+	build_dir: str,
+) -> None:
+	""" Generate documentation using Sphinx.
+	Args:
+		source_dir        (str): Source directory
+		modules_dir       (str): Modules directory
+		project_dir       (str): Project directory
+		build_dir         (str): Build directory
+	"""
+	# Generate module documentation using sphinx-apidoc
+	subprocess.run([
+		sys.executable,
+		"-m", "sphinx.ext.apidoc",
+		"-o", modules_dir,
+		"-f", "-e", "-M",
+		"--no-toc",
+		"-P",
+		"--implicit-namespaces",
+		"--module-first",
+		project_dir,
+	], check=True)
+	# Build HTML documentation
+	subprocess.run([
+		sys.executable,
+		"-m", "sphinx",
+		"-b", "html",
+		"-a",
+		source_dir,
+		build_dir,
+	], check=True)
+def generate_redirect_html(filepath: str) -> None:
+	""" Generate HTML content for redirect page.
+	Args:
+		filepath (str): Path to the file where the HTML content should be written
+	"""
+	with super_open(filepath, "w", encoding="utf-8") as f:
+		f.write("""<!DOCTYPE html>
+<html lang="en">
+<head>
+	<meta charset="UTF-8">
+	<meta name="viewport" content="width=device-width, initial-scale=1.0">
+	<meta http-equiv="refresh" content="0;url=./latest/">
+	<title>Redirecting...</title>
+</head>
+<body>
+	<p>If you are not redirected automatically, <a href="./latest/">click here</a>.</p>
+</body>
+</html>
+""")
+@handle_error()
+def update_documentation(
+	root_path: str,
+	project: str,
+	author: str = "Author",
+	copyright: str = "2025, Author",
+	html_logo: str = "",
+	html_favicon: str = "",
+	github_user: str = "",
+	github_repo: str = "",
+	version: str | None = None,
+	skip_undocumented: bool = True,
+	get_versions_function: Callable[[str, str], list[str]] = get_versions_from_github,
+	generate_index_function: Callable[..., None] = generate_index_rst,
+	generate_docs_function: Callable[..., None] = generate_documentation,
+	generate_redirect_function: Callable[[str], None] = generate_redirect_html,
+	get_conf_content_function: Callable[..., str] = get_sphinx_conf_content
+) -> None:
+	""" Update the Sphinx documentation.
+	Args:
+		root_path                  (str): Root path of the project
+		project                    (str): Name of the project
+		author                     (str): Author of the project
+		copyright                  (str): Copyright information
+		html_logo                  (str): URL to the logo
+		html_favicon               (str): URL to the favicon
+		github_user                (str): GitHub username
+		github_repo                (str): GitHub repository name
+		version                    (str | None): Version to build documentation for (e.g. "1.0.0", defaults to "latest")
+		skip_undocumented          (bool): Whether to skip undocumented members. Defaults to True
+		get_versions_function      (Callable[[str, str], list[str]]): Function to get versions from GitHub
+		generate_index_function    (Callable[..., None]): Function to generate index.rst
+		generate_docs_function     (Callable[..., None]): Function to generate documentation
+		generate_redirect_function (Callable[[str], None]): Function to create redirect file
+		get_conf_content_function  (Callable[..., str]): Function to get Sphinx conf.py content
+	"""
+	# Setup paths
+	root_path = clean_path(root_path)
+	docs_dir: str = f"{root_path}/docs"
+	source_dir: str = f"{docs_dir}/source"
+	modules_dir: str = f"{source_dir}/modules"
+	static_dir: str = f"{source_dir}/_static"
+	templates_dir: str = f"{source_dir}/_templates"
+	html_dir: str = f"{docs_dir}/build/html"
+	# Remove "v" from version if it is a string (just in case)
+	version = version.replace("v", "") if isinstance(version, str) else version
+	# Modify build directory if version is specified
+	build_dir: str = f"{html_dir}/latest" if not version else f"{html_dir}/v{version}"
+	# Create directories if they don't exist
+	for dir in [modules_dir, static_dir, templates_dir]:
+		os.makedirs(dir, exist_ok=True)
+	# Generate index.rst from README.md
+	readme_path: str = f"{root_path}/README.md"
+	index_path: str = f"{source_dir}/index.rst"
+	generate_index_function(
+		readme_path=readme_path,
+		index_path=index_path,
+		project=project,
+		github_user=github_user,
+		github_repo=github_repo,
+		get_versions_function=get_versions_function,
+	)
+	# Clean up old module documentation
+	if os.path.exists(modules_dir):
+		shutil.rmtree(modules_dir)
+		os.makedirs(modules_dir)
+	# Get versions and current version for conf.py
+	version_list: list[str] = get_versions_function(github_user, github_repo)
+	current_version: str = version if version else "latest"
+	# Generate conf.py
+	conf_path: str = f"{source_dir}/conf.py"
+	conf_content: str = get_conf_content_function(
+		project=project,
+		author=author,
+		current_version=current_version,
+		copyright=copyright,
+		html_logo=html_logo,
+		html_favicon=html_favicon,
+		github_user=github_user,
+		github_repo=github_repo,
+		version_list=version_list,
+		skip_undocumented=skip_undocumented,
+	)
+	with open(conf_path, "w", encoding="utf-8") as f:
+		f.write(conf_content)
+	# Generate documentation
+	generate_docs_function(
+		source_dir=source_dir,
+		modules_dir=modules_dir,
+		project_dir=f"{root_path}/{project}",
+		build_dir=build_dir,
+	)
+	# Add index.html to the build directory that redirects to the latest version
+	generate_redirect_function(f"{html_dir}/index.html")
+	info(f"Documentation updated successfully!")
+	info(f"You can view the documentation by opening {build_dir}/index.html")

stouputils-1.2.2/stouputils/continuous_delivery/__init__.py ADDED Viewed

@@ -0,0 +1,24 @@
+""" 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
+"""
+# Imports
+from .cd_utils import *
+from .github import *
+from .pypi import *
+from .pyproject import *

{stouputils-1.2.0 → stouputils-1.2.2}/stouputils/continuous_delivery/cd_utils.py RENAMED Viewed

@@ -78,3 +78,58 @@ def handle_response(response: requests.Response, error_message: str) -> None:
 		except requests.exceptions.JSONDecodeError:
 			raise ValueError(f"{error_message}, response code {response.status_code} with response {response.text}")
+# 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.2.0 → stouputils-1.2.2}/stouputils/continuous_delivery/github.py RENAMED Viewed

@@ -10,7 +10,7 @@
 from ..print import info, warning, progress
 from ..decorators import measure_time, handle_error
 from ..io import clean_path
-from .cd_utils import handle_response
+from .cd_utils import handle_response, version_to_float, clean_version
 from typing import Any
 import requests
 import os
@@ -140,59 +140,6 @@ def delete_existing_tag(tag_url: str, headers: dict[str, str]) -> None:
 	handle_response(delete_response, "Failed to delete existing tag")
 	info("Deleted existing tag")
-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)
-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
 def get_latest_tag(owner: str, project_name: str, version: str, headers: dict[str, str]) -> tuple[str, str] | tuple[None, None]:
 	""" Get latest tag information

{stouputils-1.2.0 → stouputils-1.2.2}/stouputils/print.py RENAMED Viewed

@@ -83,15 +83,23 @@ def info(*values: Any, color: str = GREEN, text: str = "INFO ", prefix: str = ""
 				print(remove_colors(message), *(remove_colors(str(v)) for v in values), file=log_file, **print_kwargs)
 def debug(*values: Any, **print_kwargs: Any) -> None:
-	""" Print a debug message looking like "[DEBUG HH:MM:SS] message" """
+	""" Print a debug message looking like "[DEBUG HH:MM:SS] message" in blue by default. """
 	if "text" not in print_kwargs:
 		print_kwargs["text"] = "DEBUG"
 	if "color" not in print_kwargs:
 		print_kwargs["color"] = BLUE
 	info(*values, **print_kwargs)
+def alt_debug(*values: Any, **print_kwargs: Any) -> None:
+	""" Print a debug message looking like "[DEBUG HH:MM:SS] message" in cyan by default. """
+	if "text" not in print_kwargs:
+		print_kwargs["text"] = "DEBUG"
+	if "color" not in print_kwargs:
+		print_kwargs["color"] = CYAN
+	info(*values, **print_kwargs)
 def suggestion(*values: Any, **print_kwargs: Any) -> None:
-	""" Print a suggestion message looking like "[SUGGESTION HH:MM:SS] message" """
+	""" Print a suggestion message looking like "[SUGGESTION HH:MM:SS] message" in cyan by default. """
 	if "text" not in print_kwargs:
 		print_kwargs["text"] = "SUGGESTION"
 	if "color" not in print_kwargs:
@@ -99,7 +107,7 @@ def suggestion(*values: Any, **print_kwargs: Any) -> None:
 	info(*values, **print_kwargs)
 def progress(*values: Any, **print_kwargs: Any) -> None:
-	""" Print a progress message looking like "[PROGRESS HH:MM:SS] message" """
+	""" Print a progress message looking like "[PROGRESS HH:MM:SS] message" in magenta by default. """
 	if "text" not in print_kwargs:
 		print_kwargs["text"] = "PROGRESS"
 	if "color" not in print_kwargs:
@@ -107,7 +115,7 @@ def progress(*values: Any, **print_kwargs: Any) -> None:
 	info(*values, **print_kwargs)
 def warning(*values: Any, **print_kwargs: Any) -> None:
-	""" Print a warning message looking like "[WARNING HH:MM:SS] message" in sys.stderr """
+	""" Print a warning message looking like "[WARNING HH:MM:SS] message" in yellow by default and in sys.stderr. """
 	if "file" not in print_kwargs:
 		print_kwargs["file"] = sys.stderr
 	if "text" not in print_kwargs:
@@ -117,7 +125,7 @@ def warning(*values: Any, **print_kwargs: Any) -> None:
 	info(*values, **print_kwargs)
 def error(*values: Any, exit: bool = True, **print_kwargs: Any) -> None:
-	""" Print an error message (in sys.stderr) and optionally ask the user to continue or stop the program
+	""" Print an error message (in sys.stderr and in red by default) and optionally ask the user to continue or stop the program.
 	Args:
 		values			(Any):		Values to print (like the print function)
@@ -144,7 +152,7 @@ def error(*values: Any, exit: bool = True, **print_kwargs: Any) -> None:
 			print(file=file)
 			sys.exit(1)
-def whatisit(*values: Any, print_function: Callable[..., None] = debug, max_length: int = 250, **print_kwargs: Any) -> None:
+def whatisit(*values: Any, print_function: Callable[..., None] = debug, max_length: int = 250, color: str = CYAN, **print_kwargs: Any) -> None:
 	""" Print the type of each value and the value itself, with its id and length/shape.
 	The output format is: "type, <id id_number>:	(length/shape) value"
@@ -153,10 +161,13 @@ def whatisit(*values: Any, print_function: Callable[..., None] = debug, max_leng
 		values			(Any):		Values to print
 		print_function	(Callable):	Function to use to print the values (default: debug())
 		max_length		(int):		Maximum length of the value string to print (default: 250)
+		color			(str):		Color of the message (default: CYAN)
 		print_kwargs	(dict):		Keyword arguments to pass to the print function
 	"""
 	def _internal(value: Any) -> str:
 		""" Get the string representation of the value, with length or shape instead of length if shape is available """
+		# Get the length or shape of the value
 		length: str = ""
 		try:
 			length = f"(length: {len(value)}) "
@@ -166,14 +177,22 @@ def whatisit(*values: Any, print_function: Callable[..., None] = debug, max_leng
 			length = f"(shape: {value.shape}) "
 		except (AttributeError, TypeError):
 			pass
+		# Get the string representation of the value
 		value_str: str = str(value)
 		if len(value_str) > max_length:
 			value_str = value_str[:max_length] + "..."
 		if "\n" in value_str:
-			length = "\n" + length	# Add a newline before the length if there is a newline in the value.
+			value_str = "\n" + value_str	# Add a newline before the value if there is a newline in it.
+		# Return the formatted string
 		return f"{type(value)}, <id {id(value)}>: {length}{value_str}"
-	# Print
+	# Add the color to the message
+	if "color" not in print_kwargs:
+		print_kwargs["color"] = color
+	# Print the values
 	if len(values) > 1:
 		print_function("(What is it?)", **print_kwargs)
 		for value in values:

stouputils-1.2.0/PKG-INFO DELETED Viewed

@@ -1,60 +0,0 @@
-Metadata-Version: 2.4
-Name: stouputils
-Version: 1.2.0
-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
-Author-email: Stoupy51 <stoupy51@gmail.com>
-License-File: LICENSE
-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.0
-Requires-Dist: requests>=2.30.0
-Requires-Dist: toml>=0.10.0
-Requires-Dist: tqdm>=4.66.0
-Description-Content-Type: text/markdown
-# 🛠️ Project Badges
-[![GitHub](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=github&label=GitHub)](https://github.com/Stoupy51/stouputils/releases/latest)
-[![PyPI - Downloads](https://img.shields.io/pypi/dm/stouputils?logo=python&label=PyPI%20downloads)](https://pypi.org/project/stouputils/)
-[![Documentation](https://img.shields.io/badge/documentation-purple?logo=sphinx)](https://stoupy51.github.io/stouputils/latest/)
-# 📚 Project Overview
-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.
-# 🚀 Project File Tree
-```bash
-stouputils/
-├── continuous_delivery/
-│   ├── github.py             # 📦 GitHub utilities that are very specific (upload_to_github)
-│   └── ...
-│
-├── print.py                  # 🖨️ Display utilities
-├── io.py                     # 💻 I/O utilities (for file management, json, etc.)
-├── decorators.py             # 🎯 Decorators (silent, measure_time, error_handler, simple_cache, deprecated)
-├── ctx.py                    # 🚫 Context managers (Muffle)
-├── archive.py                # 📦 Archive utilities (zip, unzip)
-├── parallel.py               # 🧑‍🤝‍🧑 Parallel processing (multiprocessing, multithreading)
-├── collections.py            # 🧰 Collection utilities (unique_list)
-├── all_doctests.py           # ✅ Execution of all doctests of all modules for a given path
-├── backup.py                 # 📦 Backup utilities (create_delta_backup, consolidate_backups, backup_cli)
-└── ...
-```
-## ⭐ Star History
-<a href="https://star-history.com/#Stoupy51/stouputils&Date">
- <picture>
-   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date&theme=dark" />
-   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
-   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
- </picture>
-</a>

stouputils-1.2.0/README.md DELETED Viewed

@@ -1,42 +0,0 @@
-# 🛠️ Project Badges
-[![GitHub](https://img.shields.io/github/v/release/Stoupy51/stouputils?logo=github&label=GitHub)](https://github.com/Stoupy51/stouputils/releases/latest)
-[![PyPI - Downloads](https://img.shields.io/pypi/dm/stouputils?logo=python&label=PyPI%20downloads)](https://pypi.org/project/stouputils/)
-[![Documentation](https://img.shields.io/badge/documentation-purple?logo=sphinx)](https://stoupy51.github.io/stouputils/latest/)
-# 📚 Project Overview
-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.
-# 🚀 Project File Tree
-```bash
-stouputils/
-├── continuous_delivery/
-│   ├── github.py             # 📦 GitHub utilities that are very specific (upload_to_github)
-│   └── ...
-│
-├── print.py                  # 🖨️ Display utilities
-├── io.py                     # 💻 I/O utilities (for file management, json, etc.)
-├── decorators.py             # 🎯 Decorators (silent, measure_time, error_handler, simple_cache, deprecated)
-├── ctx.py                    # 🚫 Context managers (Muffle)
-├── archive.py                # 📦 Archive utilities (zip, unzip)
-├── parallel.py               # 🧑‍🤝‍🧑 Parallel processing (multiprocessing, multithreading)
-├── collections.py            # 🧰 Collection utilities (unique_list)
-├── all_doctests.py           # ✅ Execution of all doctests of all modules for a given path
-├── backup.py                 # 📦 Backup utilities (create_delta_backup, consolidate_backups, backup_cli)
-└── ...
-```
-## ⭐ Star History
-<a href="https://star-history.com/#Stoupy51/stouputils&Date">
- <picture>
-   <source media="(prefers-color-scheme: dark)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date&theme=dark" />
-   <source media="(prefers-color-scheme: light)" srcset="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
-   <img alt="Star History Chart" src="https://api.star-history.com/svg?repos=Stoupy51/stouputils&type=Date" />
- </picture>
-</a>

stouputils-1.2.0/stouputils/__init__.py DELETED Viewed

@@ -1,15 +0,0 @@
-# Imports
-from .print import *
-from .archive import *
-from .io import *
-from .decorators import *
-from .ctx import *
-from .parallel import *
-from .all_doctests import *
-from .collections import *
-from .backup import *
-# Folders
-from .continuous_delivery import *