maxson-gui-utils 0.1.2__tar.gz

maxson_gui_utils-0.1.2/LICENSE

@@ -0,0 +1,10 @@
+MIT
+
+Copyright © 2026 George Clayton Bennett 
+https://github.com/City-of-Memphis-Wastewater/maxson-gui-utils/
+
+Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the “Software”), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED “AS IS”, WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

maxson_gui_utils-0.1.2/MANIFEST.in

@@ -0,0 +1,4 @@
+include src/maxson_gui_utils/data/*
+recursive-include src/maxson_gui_utils/data/themes *
+recursive-include src/maxson_gui_utils/data/icons *
+

maxson_gui_utils-0.1.2/PKG-INFO

@@ -0,0 +1,45 @@
+Metadata-Version: 2.4
+Name: maxson-gui-utils
+Version: 0.1.2
+Summary: A Python application.
+Author-email: Your Name <you@example.com>
+Maintainer-email: Your Name <you@example.com>
+License-Expression: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Typing :: Typed
+Classifier: Development Status :: 3 - Alpha
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: dworshak-config>=0.2.8
+Requires-Dist: pyhabitat>=1.3.9
+Requires-Dist: typer>=0.27.0
+Requires-Dist: typer-helptree>=0.2.12
+Dynamic: license-file
+
+# maxson-gui-utils
+
+Centralized theme and TKinter helpers. 
+Used alongside maxson-build-utils.
+
+---
+
+## Helptree
+
+See the `maxson-gui-utils` Typer CLI structure.
+
+```
+maxson-gui-utils helptree
+```
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/City-of-Memphis-Wastewater/maxson-gui-utils/main/assets/assets/maxson-gui-utils_v0.1.0_helptree.svg" width="100%" alt="SVG of the CLI helptree">
+</p>

maxson_gui_utils-0.1.2/README.md

@@ -0,0 +1,18 @@
+# maxson-gui-utils
+
+Centralized theme and TKinter helpers. 
+Used alongside maxson-build-utils.
+
+---
+
+## Helptree
+
+See the `maxson-gui-utils` Typer CLI structure.
+
+```
+maxson-gui-utils helptree
+```
+
+<p align="center">
+  <img src="https://raw.githubusercontent.com/City-of-Memphis-Wastewater/maxson-gui-utils/main/assets/assets/maxson-gui-utils_v0.1.0_helptree.svg" width="100%" alt="SVG of the CLI helptree">
+</p>

maxson_gui_utils-0.1.2/pyproject.toml

@@ -0,0 +1,109 @@
+[project]
+name = "maxson-gui-utils"
+dynamic = ["version"]
+description = "A Python application."
+readme = "README.md"
+requires-python = ">=3.10"
+
+dependencies = [
+    "dworshak-config>=0.2.8",
+    "pyhabitat>=1.3.9",
+    "typer>=0.27.0",
+    "typer-helptree>=0.2.12",
+]
+
+license = "MIT"
+license-files = ["LICENSE"]
+
+authors = [
+    { name = "Your Name", email = "you@example.com" }
+]
+
+maintainers = [
+    { name = "Your Name", email = "you@example.com" }
+]
+
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Programming Language :: Python :: 3.14",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Typing :: Typed",
+    "Development Status :: 3 - Alpha",
+    #"Development Status :: 4 - Beta",
+    #"Development Status :: 5 - Production/Stable",
+]
+
+keywords = [
+
+]
+
+#[project.urls]
+#Homepage = ""
+#Repository = ""
+#Issues = ""
+#Changelog = ""
+
+[project.scripts]
+"maxson-gui-utils" = "maxson_gui_utils.__main__:app"
+"mgu" = "maxson_gui_utils.__main__:app"
+
+[dependency-groups]
+test = [
+    "pytest>=8.0.0",
+    "pytest-cov>=4.1.0",
+]
+dev = [
+    { include-group = "test" },
+    "build>=1.3.0",
+    "pyinstaller>=6.17.0 ; platform_system == 'Linux' and platform_machine != 'aarch64'",
+    "shiv>=1.0.8",
+    "ruff>=0.7.0 ; platform_system == 'Linux' and platform_machine != 'aarch64'",
+    "maxson-build-utils>=0.1.33",
+]
+
+
+[build-system]
+requires = ["setuptools>=64", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.uv.sources]
+"maxson-gui-utils" = { path = "src/maxson_gui_utils" }
+
+#[tool.setuptools]
+#packages = ["maxson_gui_utils"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.setuptools.dynamic]
+version = { file = "src/maxson_gui_utils/VERSION" }
+
+[tool.setuptools.package-data]
+"maxson_gui_utils" = [
+    "data/*",
+    "data/icons/*",
+    "data/icons/**/*",
+    "data/themes/*",
+    "data/themes/**/*",
+]
+
+[tool.maxson-build-utils.names]
+import = "maxson_gui_utils"
+pretty = "Maxson Gui Utils"
+
+[tool.maxson-build-utils.pyinstaller]
+mode = "onedir"
+windowed = false
+collect_data_pkgs = ["maxson_gui_utils"]
+collect_binary_pkgs = []
+
+[tool.maxson-build-utils.packaging.msix]
+publisher = "CN=806FDEBD-B014-4625-85AE-058C714FC7F2"
+publisher_display_name = "George Clayton Bennett"
+identity_name = "GeorgeClaytonBennett.MaxsonGuiUtils"

maxson_gui_utils-0.1.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

maxson_gui_utils-0.1.2/src/maxson_gui_utils/VERSION

@@ -0,0 +1,2 @@
+0.1.2
+

maxson_gui_utils-0.1.2/src/maxson_gui_utils/__init__.py

@@ -0,0 +1,80 @@
+#!/usr/bin/env python3
+# src/maxson_gui_utils/__init__.py
+from __future__ import annotations
+
+import os
+
+from ._version import __version__
+
+# 1. Clean public-facing mapping
+__all__ = [
+    "__version__",
+
+    "__gui_easteregg_enabled__",
+]
+
+
+def _check_easteregg_env() -> bool:
+    """Helper to dynamically read environment state at call-time."""
+    env_flag = os.environ.get("MGU_GUI_EASTEREGG", "").strip().lower()
+    return env_flag in ("true", "1", "yes", "on")
+
+
+# 2. Fully dynamic attribute routing
+def __getattr__(name: str):
+
+    # Dynamic boolean evaluation for the breadcrumb attribute
+    if name == "__gui_easteregg_enabled__":
+        return _check_easteregg_env()
+
+    # Dynamic lookups for the GUI function invocation
+    if name == "start_gui":
+
+        def _missing_gui():
+            raise RuntimeError(
+                "start_gui requires pyhabitat and a Tkinter-capable environment"
+            )
+
+        _missing_gui.__name__ = "start_gui"
+        _missing_gui.__doc__ = (
+            "GUI support is unavailable in this environment."
+        )
+
+        if _check_easteregg_env():
+            try:
+                import pyhabitat
+
+                if pyhabitat.tkinter_is_available():
+                    from .gui import start_gui
+
+                    return start_gui
+            except ImportError:
+                pass
+
+        return _missing_gui
+
+    raise AttributeError(f"module {__name__!r} has no attribute {name!r}")
+
+
+# 3. Dynamic introspection reflecting runtime changes
+def __dir__():
+    exported = list(__all__)
+    if _check_easteregg_env():
+        exported.append("start_gui")
+
+    return sorted(
+        exported
+        + [
+            "__builtins__",
+            "__cached__",
+            "__doc__",
+            "__file__",
+            "__getattr__",
+            "__dir__",
+            "__loader__",
+            "__name__",
+            "__package__",
+            "__path__",
+            "__spec__",
+        ]
+    )

maxson_gui_utils-0.1.2/src/maxson_gui_utils/__main__.py

@@ -0,0 +1,7 @@
+# src/maxson_gui_utils/__main__.py
+from __future__ import annotations
+
+from maxson_gui_utils.cli import app
+
+if __name__ == "__main__":
+    app()

maxson_gui_utils-0.1.2/src/maxson_gui_utils/_version.py

@@ -0,0 +1,23 @@
+
+# src/maxson_gui_utils/_version.py
+from pathlib import Path
+from .context import APP_NAME
+def get_version() -> str:
+    try:
+        version_file = Path(__file__).parent / "VERSION"
+        if version_file.exists():
+            return version_file.read_text(encoding="utf-8").strip()
+    except Exception:
+        pass
+
+    # Try metadata (Installed)
+    try:
+        from importlib.metadata import version, PackageNotFoundError
+        return version(APP_NAME)
+    except (ImportError, PackageNotFoundError):
+        pass
+
+
+    return "0.0.0-unknown"
+
+__version__ = get_version()

maxson_gui_utils-0.1.2/src/maxson_gui_utils/cli.py

@@ -0,0 +1,152 @@
+#!/usr/bin/env python3
+# src/maxson_gui_utils/cli.py
+
+from __future__ import annotations
+
+import logging
+import os
+import sys
+from pathlib import Path
+import pyhabitat
+import typer
+from typer.models import OptionInfo
+from rich.console import Console
+from typer_helptree import add_typer_helptree
+
+from ._version import __version__
+from .context import APP_NAME, DESCRIPTION_STR
+from .logging_setup import (
+    configure_logging_all_debug,
+    configure_logging_for_application,
+)
+
+logger = logging.getLogger(__name__)
+
+console_stderr = Console(stderr=True)
+console_stdout = Console()
+
+# Force Rich to always enable colors, even when running from a .pyz bundle.
+os.environ["FORCE_COLOR"] = "1"
+
+# Optional but helpful for full terminal feature detection.
+os.environ["TERM"] = "xterm-256color"
+
+app = typer.Typer(
+    name=APP_NAME,
+    help=f"{DESCRIPTION_STR} (v{__version__})",
+    add_completion=False,
+    invoke_without_command=True,
+    no_args_is_help=True,
+    context_settings={
+        "ignore_unknown_options": True,
+        "allow_extra_args": True,
+        "help_option_names": ["-h", "--help"],
+    },
+)
+
+
+@app.callback(invoke_without_command=True)
+def main(
+    ctx: typer.Context,
+    version: bool = typer.Option(
+        False,
+        "--version",
+        "-V",
+        help="Show application version and exit.",
+    ),
+    debug: bool = typer.Option(
+        False,
+        "--debug",
+        "-d",
+        help="Enable debug level logs for app.",
+    ),
+    all_debug: bool = typer.Option(
+        False,
+        "--all-debug",
+        help="Enable debug logs for app AND dependencies.",
+    ),
+    verbose: bool = typer.Option(
+        False,
+        "--verbose",
+        "-v",
+        help="Enable verbose info level logs.",
+    ),
+    log_file: Path | None = typer.Option(
+        None,
+        "--log-file",
+        help="Custom path to output log file.",
+    ),
+):
+    if version:
+        typer.echo(__version__)
+        raise typer.Exit()
+
+    if all_debug:
+        configure_logging_all_debug()
+    else:
+        configure_logging_for_application(
+            debug=debug,
+            verbose=verbose,
+            log_to_file=log_file is not None,
+        )
+
+    logger.debug("Executing command: %s", " ".join(sys.argv))
+
+    if ctx.invoked_subcommand is None and not ctx.resilient_parsing:
+        typer.echo(ctx.get_help())
+        raise typer.Exit()
+
+
+add_typer_helptree(
+    app=app,
+    console=console_stderr,
+    version=__version__,
+    hidden=False,
+)
+
+@app.command(name="gui")
+def gui_command(
+    auto_close: int = typer.Option(0,
+   "--auto-close", "-c",
+   help = "Delay in milliseconds after which the GUI window will close (for automated testing). Use 0 to disable auto-closing.",
+   min=0)
+    )->None:
+    """
+    Launch tkinter-based GUI.
+    """
+    assured_auto_close_value = 0
+
+    # --- Helper, consistent gui failure message. ---
+    def _gui_failure_msg():
+        console_stderr.print("[bold red]GUI failed to launch[/bold red]")
+        console_stderr.print("Use 'pdflinkcheck analyze CLI' instead.")
+        console_stderr.print(f"pyhabitat.tkinter_is_available() = {pyhabitat.tkinter_is_available()}")
+        console_stderr.print(f"pyhabitat.on_termux() = {pyhabitat.on_termux()}")
+
+    if isinstance(auto_close, OptionInfo):
+        # Case 1: Called implicitly from main() (pdflinkcheck with no args)
+        # We received the metadata object, so use the function's default value (0).
+        # We don't need to do anything here since final_auto_close_value is already 0.
+        pass
+    else:
+        # Case 2: Called explicitly by Typer (pdflinkcheck gui -c 3000)
+        # Typer has successfully converted the command line argument, and auto_close is an int.
+        assured_auto_close_value = int(auto_close)
+
+    if not pyhabitat.tkinter_is_available():
+        _gui_failure_msg()
+        return
+
+    from .gui import start_gui
+    start_gui(time_auto_close = assured_auto_close_value)
+
+@app.command(name="placeholder")
+def placeholder(
+    path: Path = Path("path"),
+):
+    """Placeholder."""
+    console_stderr.print(f"{path=}")
+
+
+if __name__ == "__main__":
+    app()

maxson_gui_utils-0.1.2/src/maxson_gui_utils/config.py

@@ -0,0 +1,9 @@
+# src/maxson_gui_utils/config.py
+from __future__ import annotations
+
+
+def get_config_mngr():
+    from .context import APP_DIR
+    from dworshak_config import DworshakConfig
+    return DworshakConfig(path=APP_DIR / "config.json")
+

maxson_gui_utils-0.1.2/src/maxson_gui_utils/context.py

@@ -0,0 +1,17 @@
+# src/maxson_gui_utils/context.py
+from __future__ import annotations
+
+from pathlib import Path
+
+PACKAGE_DIR = Path(__file__).resolve().parent
+SRC_DIR = PACKAGE_DIR.parent
+PROJECT_ROOT = SRC_DIR.parent
+
+APP_NAME = "maxson-gui-utils"
+APP_NAME_PRETTY = "Maxson Gui Utils"
+IMPORT_NAME = "maxson_gui_utils"
+SRC_FOLDER_NAME = "maxson_gui_utils"
+DESCRIPTION_STR = "A Python application."
+APP_DIR = Path.home() / ".maxson-gui-utils"
+LOG_FILE_PATH = "/home/oolong/.maxson-gui-utils/maxson-gui-utils.log"
+SERVICE = APP_NAME

maxson_gui_utils-0.1.2/src/maxson_gui_utils/core.py

@@ -0,0 +1,3 @@
+# src/maxson_gui_utils/core.py
+
+from __future__ import annotations

maxson_gui_utils-0.1.2/src/maxson_gui_utils/data/icons/water-green.svg

@@ -0,0 +1,7 @@
+<!DOCTYPE svg PUBLIC "-//W3C//DTD SVG 1.1//EN" "http://www.w3.org/Graphics/SVG/1.1/DTD/svg11.dtd">
+
+<svg version="1.1" id="_x32_" xmlns="http://www.w3.org/2000/svg" xmlns:xlink="http://www.w3.org/1999/xlink" width="800px" height="800px" viewBox="0 0 512 512" xml:space="preserve" fill="#1b6333">
+
+
+
+