hspylib-clitt 0.9.119__py3-none-any.whl → 0.9.121__py3-none-any.whl

build/lib/build/lib/build/lib/build/lib/clitt/core/tui/tui_component.py

@@ -1,154 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-"""
-   @project: HsPyLib-Clitt
-   @package: clitt.core.tui
-      @file: tui_component.py
-   @created: Tue, 4 May 2021
-    @author: <B>H</B>ugo <B>S</B>aporetti <B>J</B>unior"
-      @site: https://github.com/yorevs/hspylib
-   @license: MIT - Please refer to <https://opensource.org/licenses/MIT>
-
-   Copyright·(c)·2024,·HSPyLib
-"""
-from abc import ABC, abstractmethod
-from clitt.core.icons.font_awesome.awesome import Awesome
-from clitt.core.term.commons import Direction
-from clitt.core.term.cursor import Cursor
-from clitt.core.term.screen import Screen
-from clitt.core.term.terminal import Terminal
-from clitt.core.tui.tui_preferences import TUIPreferences
-from hspylib.core.tools.text_tools import elide_text
-from hspylib.modules.cli.keyboard import Keyboard
-from typing import Any, List, Optional, TypeVar
-
-T = TypeVar("T", bound=Any)
-
-
-class TUIComponent(ABC):
-    """Provide a base class for terminal UI components."""
-
-    def __init__(self, title: str):
-        self._re_render = True
-        self._done = False
-        self._title = title
-        self._terminal = Terminal.INSTANCE
-
-    @property
-    def terminal(self) -> Terminal:
-        return self._terminal
-
-    @property
-    def screen(self) -> Screen:
-        return self.terminal.screen
-
-    @property
-    def cursor(self) -> Cursor:
-        return self.terminal.screen.cursor
-
-    @property
-    def prefs(self) -> TUIPreferences:
-        return self.screen.preferences
-
-    @property
-    def title(self) -> str:
-        return self._title
-
-    @property
-    def rows(self) -> int:
-        return self.screen.lines
-
-    @property
-    def columns(self) -> int:
-        return self.screen.columns
-
-    def _prepare_render(self, auto_wrap: bool = False, show_cursor: bool = False) -> None:
-        """Prepare the screen for renderization."""
-        self.screen.add_watcher(self.invalidate)
-        Terminal.set_auto_wrap(auto_wrap)
-        Terminal.set_show_cursor(show_cursor)
-        self.screen.clear()
-        self.cursor.save()
-
-    def _loop(self, break_keys: List[Keyboard] = None) -> Keyboard:
-        """Loop and wait for a keypress. Render the component if required."""
-
-        break_keys = break_keys or Keyboard.break_keys()
-        keypress = Keyboard.VK_NONE
-
-        # Wait for user interaction
-        while not self._done and keypress not in break_keys:
-
-            # Menu Renderization
-            if self._re_render:
-                self.render()
-            # Navigation input
-            keypress = self.handle_keypress()
-
-        self.cursor.end()
-        self.cursor.erase(Direction.DOWN)
-        self.cursor.reset_mode()
-        self.cursor.writeln("\n")
-
-        return keypress
-
-    def draw_line(self, line_fmt: str, *args: Any) -> None:
-        """Draws a formatted component line respecting the specified max_columns.
-        :param line_fmt: the line format.
-        :param args: the format arguments.
-        """
-        self.writeln(elide_text(line_fmt.format(*args), self.columns) + "%NC%")
-
-    def draw_navbar(self, navbar: str) -> None:
-        """Draws the component navigation bar respecting the specified max_columns.
-        :param navbar: the component's navigation bar.
-        """
-        self.write(navbar)
-
-    def draw_selector(self, is_selected: bool = False, has_bg_color: bool = True) -> Awesome:
-        """Draws and highlight the selected component line.
-        :param is_selected: whether to set a selected foreground color or not.
-        :param has_bg_color: whether to set a background or not.
-        """
-        prefs = TUIPreferences.INSTANCE
-        if is_selected:
-            selector = prefs.selected_icon
-            if has_bg_color:
-                self.write(prefs.sel_bg_color.code)
-            self.write(prefs.highlight_color.code)
-        else:
-            selector = prefs.unselected_icon
-            self.write(prefs.text_color.code)
-
-        return selector
-
-    def write(self, obj: Any) -> None:
-        """Write the string representation of the object to the screen."""
-        self.terminal.echo(obj, end="")
-
-    def writeln(self, obj: Any) -> None:
-        """Write the string representation of the object to the screen, appending a new line."""
-        self.terminal.echo(obj)
-
-    def invalidate(self) -> None:
-        """Invalidate current TUI renderization."""
-        self.screen.clear()
-        self.cursor.save()
-        self.render()
-
-    @abstractmethod
-    def execute(self) -> Optional[T | List[T]]:
-        """Execute the main TUI component flow."""
-
-    @abstractmethod
-    def render(self) -> None:
-        """Renders the TUI component."""
-
-    @abstractmethod
-    def navbar(self, **kwargs) -> str:
-        """Get the TUI component's navigation bar (optional)."""
-
-    @abstractmethod
-    def handle_keypress(self) -> Keyboard:
-        """Handle a keyboard press."""

build/lib/build/lib/build/lib/build/lib/clitt/core/tui/tui_preferences.py

@@ -1,103 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-"""
-   @project: HsPyLib-Clitt
-   @package: clitt.core.tui
-      @file: tui_preferences.py
-   @created: Tue, 4 May 2021
-    @author: <B>H</B>ugo <B>S</B>aporetti <B>J</B>unior"
-      @site: https://github.com/yorevs/hspylib
-   @license: MIT - Please refer to <https://opensource.org/licenses/MIT>
-
-   Copyright·(c)·2024,·HSPyLib
-"""
-
-from clitt.core.icons.font_awesome.form_icons import FormIcons
-from clitt.core.icons.font_awesome.nav_icons import Awesome, NavIcons
-from clitt.core.preferences import Preferences
-from hspylib.modules.cli.vt100.vt_color import VtColor
-
-
-class TUIPreferences(Preferences):
-    """Terminal UI Preferences class."""
-
-    INSTANCE = None
-
-    def __init__(self):
-        super().__init__("hhs.clitt")
-
-    @property
-    def max_rows(self) -> int:
-        return max(3, self.get_preference("max.rows", 10))
-
-    @property
-    def items_per_line(self) -> int:
-        return max(2, self.get_preference("items.per.line", 6))
-
-    @property
-    def title_line_length(self) -> int:
-        return max(15, self.get_preference("title.line.len", 30))
-
-    @property
-    def title_color(self) -> VtColor:
-        return self.get_preference("title.color", VtColor.ORANGE)
-
-    @property
-    def caption_color(self) -> VtColor:
-        return self.get_preference("caption.color", VtColor.WHITE)
-
-    @property
-    def text_color(self) -> VtColor:
-        return self.get_preference("text.color", VtColor.WHITE)
-
-    @property
-    def success_color(self) -> VtColor:
-        return self.get_preference("success.color", VtColor.GREEN)
-
-    @property
-    def warning_color(self) -> VtColor:
-        return self.get_preference("warning.color", VtColor.YELLOW)
-
-    @property
-    def error_color(self) -> VtColor:
-        return self.get_preference("error.color", VtColor.RED)
-
-    @property
-    def highlight_color(self) -> VtColor:
-        return self.get_preference("highlight.color", VtColor.CYAN)
-
-    @property
-    def navbar_color(self) -> VtColor:
-        return self.get_preference("navbar.color", VtColor.YELLOW)
-
-    @property
-    def tooltip_color(self) -> VtColor:
-        return self.get_preference("tooltip.color", VtColor.GREEN)
-
-    @property
-    def breadcrumb_color(self) -> VtColor:
-        return self.get_preference("breadcrumb.color", VtColor.compose(VtColor.BG_BLUE, VtColor.WHITE))
-
-    @property
-    def sel_bg_color(self) -> VtColor:
-        return self.get_preference("sel.bg.color", VtColor.BLUE)
-
-    @property
-    def selected_icon(self) -> Awesome:
-        return self.get_preference("selected.icon", NavIcons.POINTER)
-
-    @property
-    def unselected_icon(self) -> Awesome:
-        return self.get_preference("unselected.icon", Awesome.no_icon())
-
-    @property
-    def checked_icon(self) -> Awesome:
-        return self.get_preference("checked.icon", FormIcons.MARKED)
-
-    @property
-    def unchecked_icon(self) -> Awesome:
-        return self.get_preference("unchecked.icon", FormIcons.UNMARKED)
-
-
-assert (tui_preferences := TUIPreferences().INSTANCE) is not None, "Failed to create TUIPreferences instance"

build/lib/build/lib/build/lib/build/lib/clitt/utils/__init__.py

@@ -1,11 +0,0 @@
-# _*_ coding: utf-8 _*_
-#
-# hspylib-clitt v0.9.119
-#
-# Package: main.build.lib.build.lib.build.lib.build.lib.clitt.utils
-"""Package initialization."""
-
-__all__ = [
-    'git_utils'
-]
-__version__ = '0.9.119'

build/lib/build/lib/build/lib/build/lib/clitt/utils/git_utils.py

@@ -1,66 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-"""
-   @project: HsPyLib
-   @package: clitt.utils
-      @file: git_utils.py
-   @created: Nov 14, 2019
-    @author: <B>H</B>ugo <B>S</B>aporetti <B>J</B>unior
-      @site: https://github.com/yorevs/hspylib
-   @license: MIT - Please refer to <https://opensource.org/licenses/MIT>
-
-   Copyright·(c)·2024,·HSPyLib
-"""
-from clitt.core.term.terminal import Terminal
-from hspylib.modules.application.exit_status import ExitStatus
-from typing import Tuple
-
-
-class GitTools:
-    """TODO"""
-
-    @staticmethod
-    def top_level_dir() -> Tuple[str, ExitStatus]:
-        """TODO"""
-        return Terminal.shell_exec("git rev-parse --show-toplevel")
-
-    @staticmethod
-    def current_branch() -> Tuple[str, ExitStatus]:
-        """TODO"""
-        return Terminal.shell_exec("git symbolic-ref --short HEAD")
-
-    @staticmethod
-    def changelog(from_tag: str, to_tag: str) -> Tuple[str, ExitStatus]:
-        """TODO"""
-        return Terminal.shell_exec(f"git log --oneline --pretty='format:%h %ad %s' --date=short {from_tag}^..{to_tag}^")
-
-    @staticmethod
-    def unreleased() -> Tuple[str, ExitStatus]:
-        """TODO"""
-        latest_tag = Terminal.shell_exec("git describe --tags --abbrev=0 HEAD^")
-        return Terminal.shell_exec(f"git log --oneline --pretty='format:%h %ad %s' --date=short '{latest_tag}'..HEAD")
-
-    @staticmethod
-    def release_date(tag_name: str) -> Tuple[str, ExitStatus]:
-        """TODO"""
-        return Terminal.shell_exec(f"git log -1 --pretty='format:%ad' --date=short {tag_name}")
-
-    @staticmethod
-    def tag_list() -> Tuple[str, ExitStatus]:
-        """TODO"""
-        return Terminal.shell_exec("git log --tags --simplify-by-decoration --pretty='format:%ci %d'")
-
-    @staticmethod
-    def create_tag(version: str, commit_id: str = "HEAD", description: str = None) -> Tuple[str, ExitStatus]:
-        """TODO"""
-        return Terminal.shell_exec(f"git tag -a v{version} {commit_id} -m '{description or version}'")
-
-    @staticmethod
-    def search_logs(filter_by: str = ".*") -> Tuple[str, ExitStatus]:
-        """TODO"""
-        return Terminal.shell_exec(f"git log --grep='{filter_by}' --pretty=format:'%h %ad %s' --date=short")
-
-    @staticmethod
-    def show_file(filename: str, commit_id: str = "HEAD") -> Tuple[str, ExitStatus]:
-        return Terminal.shell_exec(f"git show {commit_id}:{filename}")

build/lib/build/lib/build/lib/clitt/__classpath__.py

@@ -1,28 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-"""
-   @project: HsPyLib-Clitt
-   @package: clitt
-      @file: __classpath__.py
-   @created: Fri, 23 Dec 2022
-    @author: "<B>H</B>ugo <B>S</B>aporetti <B>J</B>unior")"
-      @site: "https://github.com/yorevs/hspylib")
-   @license: MIT - Please refer to <https://opensource.org/licenses/MIT>
-
-   Copyright·(c)·2024,·HSPyLib
-"""
-
-from hspylib.core.metaclass.classpath import Classpath
-from hspylib.core.tools.commons import get_path, run_dir
-
-
-class _Classpath(Classpath):
-    """Provide a class to help locating user-defined classes, packages, sources and resources."""
-
-    def __init__(self):
-        super().__init__(get_path(__file__), get_path(run_dir()), (get_path(__file__) / "resources"))
-
-
-# Instantiate the classpath singleton
-assert (classpath := _Classpath().INSTANCE) is not None, "Failed to create Classpath instance"

build/lib/build/lib/build/lib/clitt/__init__.py

@@ -1,13 +0,0 @@
-# _*_ coding: utf-8 _*_
-#
-# hspylib-clitt v0.9.119
-#
-# Package: main.build.lib.build.lib.build.lib.build.lib.clitt
-"""Package initialization."""
-
-__all__ = [
-    'addons', 
-    'core', 
-    'utils'
-]
-__version__ = '0.9.119'

build/lib/build/lib/build/lib/clitt/__main__.py

@@ -1,139 +0,0 @@
-#!/usr/bin/env python3
-# -*- coding: utf-8 -*-
-
-"""
-   @project: hspylib
-   @package: hspylib
-      @file: __main__.py
-   @created: Tue, 4 May 2021
-    @author: <B>H</B>ugo <B>S</B>aporetti <B>J</B>unior"
-      @site: https://github.com/yorevs/hspylib
-   @license: MIT - Please refer to <https://opensource.org/licenses/MIT>
-
-   Copyright·(c)·2024,·HSPyLib
-"""
-from clitt.__classpath__ import classpath
-from clitt.addons.appman.appman import AppManager
-from clitt.addons.appman.appman_enums import AppExtension, AppType
-from clitt.addons.widman.widman import WidgetManager
-from clitt.core.tui.tui_application import TUIApplication
-from hspylib.core.enums.charset import Charset
-from hspylib.core.enums.enumeration import Enumeration
-from hspylib.core.tools.commons import run_dir, syserr
-from hspylib.core.tools.text_tools import strip_linebreaks
-from hspylib.modules.application.exit_status import ExitStatus
-from hspylib.modules.application.version import Version
-
-import sys
-
-
-class Main(TUIApplication):
-    """HsPyLib CLI Terminal Tools - Create professional CLI applications."""
-
-    # The welcome message
-    DESCRIPTION = classpath.get_source("welcome.txt").read_text(encoding=Charset.UTF_8.val)
-
-    # Location of the .version file
-    VERSION_DIR = classpath.source_path()
-
-    class Addon(Enumeration):
-        """HsPyLib addon types."""
-
-        # fmt: off
-        APPMAN      = 'appman'
-        WIDGETS     = 'widgets'
-        # fmt: on
-
-        @property
-        def val(self) -> str:
-            return str(self.value)
-
-    def __init__(self, app_name: str):
-        version = Version.load(load_dir=self.VERSION_DIR)
-        super().__init__(app_name, version, self.DESCRIPTION.format(version))
-
-    def _setup_arguments(self) -> None:
-        """Initialize application parameters and options."""
-
-        # fmt: off
-        self._with_chained_args('application', 'the HsPyLib-Clitt addon to run') \
-            .argument(
-                    self.Addon.APPMAN.val,
-                    'app Application Manager: Create HsPyLib-Clitt based python applications') \
-                .add_option(
-                    'dest-dir', 'd', 'dest-dir',
-                    'the destination directory. If omitted, the current directory will be used.',
-                    nargs='?', default=self._run_dir) \
-                .add_parameter(
-                    'app-name', 'the application name', nargs='?') \
-                .add_parameter(
-                    'app-type',
-                    'the application type. Appman is going to scaffold a basic application based on the app type',
-                    choices=AppType.choices(), nargs='?') \
-                .add_parameter(
-                    'app-ext',
-                    '"gradle" is going to initialize you project with gradle (requires gradle). '
-                    '"git" is going to initialize a git repository (requires git)', nargs='*') \
-            .argument(self.Addon.WIDGETS.val, 'app Widgets Manager: Execute an HsPyLib widget') \
-                .add_parameter(
-                    'widget-name',
-                    'the name of the widget to be executed. If omitted, all available widgets will be '
-                    'presented in a dashboard',
-                    nargs='?') \
-                .add_parameter(
-                    'widget-args', "the widget's arguments (if applicable)", nargs='*')
-
-    def _main(self, *params, **kwargs) -> ExitStatus:
-        """Main entry point handler."""
-        return self._exec_application()
-
-    def _exec_application(self) -> ExitStatus:
-        """Execute the application main flow."""
-
-        app = self.get_arg("application")
-        if app == self.Addon.APPMAN.val:
-            self.start_appman()
-        elif app == self.Addon.WIDGETS.val:
-            self.start_widman()
-        else:
-            syserr(f"### Invalid Addon application: {app}")
-            self.usage(ExitStatus.FAILED)
-
-        return ExitStatus.SUCCESS
-
-    def start_widman(self) -> None:
-        """Start the Widman application."""
-        addon = WidgetManager(self)
-        widget_name = self.get_arg("widget-name")
-        if widget_name:
-            widget_args = list(map(strip_linebreaks, self.get_arg("widget-args")))
-            addon.execute(widget_name, *widget_args)
-        else:
-            addon.dashboard()
-
-    def start_appman(self) -> None:
-        """Start the Appman application."""
-        addon = AppManager(self)
-        app_type = self.get_arg("app-type")
-        if app_type:
-            app_ext = self.get_arg("app-ext")
-            addon.create(
-                self.get_arg("app-name"),
-                AppType.of_value(app_type),
-                list(map(AppExtension.value_of, app_ext)) if app_ext else [],
-                self.get_arg("dest-dir") or run_dir(),
-            )
-        else:
-            args = addon.prompt()
-            if args:
-                app_ext = []
-                if args.initialize_gradle:
-                    app_ext.append(AppExtension.GRADLE)
-                if args.initialize_git:
-                    app_ext.append(AppExtension.GIT)
-                addon.create(args.app_name, AppType.of_value(args.app_type), list(app_ext), args.dest_dir or run_dir())
-
-
-# Application entry point
-if __name__ == "__main__":
-    Main("clitt").INSTANCE.run(sys.argv[1:])

build/lib/build/lib/build/lib/clitt/addons/__init__.py

@@ -1,12 +0,0 @@
-# _*_ coding: utf-8 _*_
-#
-# hspylib-clitt v0.9.119
-#
-# Package: main.build.lib.build.lib.build.lib.build.lib.clitt.addons
-"""Package initialization."""
-
-__all__ = [
-    'appman', 
-    'widman'
-]
-__version__ = '0.9.119'

build/lib/build/lib/build/lib/clitt/addons/appman/__init__.py

@@ -1,13 +0,0 @@
-# _*_ coding: utf-8 _*_
-#
-# hspylib-clitt v0.9.119
-#
-# Package: main.build.lib.build.lib.build.lib.build.lib.clitt.addons.appman
-"""Package initialization."""
-
-__all__ = [
-    'appman', 
-    'appman_enums', 
-    'templates'
-]
-__version__ = '0.9.119'