ttykit 0.2.2__tar.gz → 0.3.5__tar.gz

{ttykit-0.2.2/src/ttykit.egg-info → ttykit-0.3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ttykit
-Version: 0.2.2
+Version: 0.3.5
 Summary: Helping made beatiful out in terminal
 Author: He-STALIN
 Author-email: hene.stalin@gmail.com
@@ -32,6 +32,7 @@ Keywords: tty,terminal,formatting
 Requires-Python: >=3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: keyboard
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Dynamic: license-file
@@ -47,18 +48,23 @@ Dynamic: license-file
 [![Repository](https://img.shields.io/badge/Repository-GitHub-4b93ff?style=flat&logo=github&logoColor=white)](https://github.com/He-STALIN/ttykit)
 
 </div>
+
 ---
 
 ## 📦 For Start
+### Manually:
 
 ```bash
 git clone https://github.com/He-STALIN/ttykit.git
 ```
 
 - Change dir and exec
+
 ```bash
 pip install .
 ```
+### Auto
+- exec `pip install ttykit`
 
 - And use in your projects!
 

{ttykit-0.2.2 → ttykit-0.3.5}/README.md

@@ -9,18 +9,23 @@
 [![Repository](https://img.shields.io/badge/Repository-GitHub-4b93ff?style=flat&logo=github&logoColor=white)](https://github.com/He-STALIN/ttykit)
 
 </div>
+
 ---
 
 ## 📦 For Start
+### Manually:
 
 ```bash
 git clone https://github.com/He-STALIN/ttykit.git
 ```
 
 - Change dir and exec
+
 ```bash
 pip install .
 ```
+### Auto
+- exec `pip install ttykit`
 
 - And use in your projects!
 

{ttykit-0.2.2 → ttykit-0.3.5}/pyproject.toml

@@ -8,17 +8,17 @@ include = ["ttykit*"]
 
 [project]
 name = "ttykit"
-version = "0.2.2"
+version = "0.3.5"
 description = "Helping made beatiful out in terminal"
 requires-python = ">=3.13"
 authors = [
-    { name = "He-STALIN"}, 
+    {name = "He-STALIN"}, 
     {email = "hene.stalin@gmail.com"}
     ]
 license = {file = "LICENSE"}
 readme = "README.md"
 keywords = ['tty', 'terminal', 'formatting']
-dependencies = []
+dependencies = ["keyboard"]
 
 [project.scripts]
 ttykit-spinner = "ttykit.spinner:main"

ttykit-0.3.5/src/ttykit/__init__.py

@@ -0,0 +1,69 @@
+"""Helping made beatiful out in terminal"""
+
+from .progress import Progress
+from .status import Status
+from ._state import TaskState, Colors, Styles, RESET
+from .console.console import Console
+from .console.TUI import TUI
+import traceback
+import sys
+
+__colors__ = [
+    Colors,
+    Styles,
+    RESET
+]
+
+__all__ = [
+    'Progress',
+    'Status',
+    'TaskState',
+    'Console',
+    'TUI',
+    'get_console',
+    'set_custom_hook'
+]
+
+def get_console() -> 'Console':
+    """Return a instance of `Console`"""
+    console = Console()
+    return console
+
+def custom_excepthook(exc_type, exc_value, exc_tb):
+    tb_lines = traceback.format_exception(exc_type, exc_value, exc_tb)
+    
+    # Самая длинная строка
+    error_line = f"Error: {exc_type.__name__}"
+    msg_line = f"Message: {exc_value}"
+    max_len = max(len(error_line), len(msg_line), 40)
+    
+    # Рамка
+    print(f"╔{'═' * (max_len + 4)}╗")
+    print(f"║  {Colors.RED}{error_line.ljust(max_len)}{RESET}  ║")
+    print(f"║  {Colors.RED}{msg_line.ljust(max_len)}{RESET}  ║")
+    print(f"╠{'═' * (max_len + 4)}╣")
+    
+    for line in tb_lines[-3:]:
+        clean = line.strip()
+        if len(clean) > max_len:
+            clean = clean[:max_len-3] + "..."
+        print(f"║  {clean.ljust(max_len)}  ║")
+    
+    print(f"╚{'═' * (max_len + 4)}╝")
+
+def set_custom_hook(Traceback: bool= False) -> None:
+    """
+    Set a custom methods
+
+    Args:
+        Traceback (bool): replace Traceback on custom or not. Default `False`
+    """
+
+    if Traceback:
+        print('set custom excepthook...')
+        sys.excepthook = custom_excepthook
+
+__name__ = 'ttykit'
+__author__ = 'He-STALIN'
+__version__ = '0.3.5'
+__license__ = 'MIT'

ttykit-0.3.5/src/ttykit/console/TUI.py

@@ -0,0 +1,148 @@
+import keyboard as kb
+import os, sys
+
+
+class TUI:
+    """
+    Create TUI (Text User Interface) in terminal with user menus
+
+    Args:
+        title (str): title of the `TUI`
+
+    ### Methods:
+        `addMenu(name, callback)`: add menu to UI render.
+        `Run()`: exec and start render the UI.
+        `UpdateUI()`: forced update UI Layer.
+
+    ### Examples
+
+    ```python
+    from ttykit import TUI
+
+    ui = TUI("this example UI!")
+
+    def someAction():
+        # do something
+
+    ui.addMenu("Us menu", someAction) # adding menu in UI
+
+    ui.Run() # and start render UI
+    ```
+    Out in Terminal
+    ```
+    ===[ this example UI! ]===
+
+        > Us menu
+
+        > Exit
+    
+    For control use arrows Up/Down and Enter to select
+    ```
+    """
+    def __init__(self, title: str):
+        super().__init__()
+        self.TITLE: str = title if title else "Text UI"
+        self.FOOTER: str = "For control use arrows Up/Down and Enter to select"
+        self.DEFAULT_SPACE = "   "
+        self._requestClosing: bool = False
+        self.action: int = 1
+        self._max_menus: int = 0
+        self._menus: list = []
+        kb.add_hotkey("Up", self.UpMenu)
+        kb.add_hotkey("Down", self.DownMenu)
+        kb.add_hotkey("enter", self._selectAction)
+
+    def _clearTerminal(self):
+        os.system('cls' if os.name == 'nt' else 'clear')
+
+    def _selectAction(self):
+        if self.action == self._max_menus:
+            self._requestClosing = True
+            return
+        
+        menu = self._menus[self.action - 1]
+        menu["callback"]()
+
+    def _UpMenu(self):
+        self.action -= 1
+
+        if self.action < 1:
+            self.action = self._max_menus
+
+        self.UpdateUI()
+
+    def _DownMenu(self):
+        self.action += 1
+
+        if self.action > self._max_menus:
+            self.action = 1
+
+        self.UpdateUI()
+
+    def UpdateUI(self):
+        """Update UI Layer in Terminal"""
+        TUI = ""
+        TUI += f"===[ {self.TITLE} ]==="
+        TUI += "\n\n"
+
+        _current_menu = 1
+        for menu in self._menus:
+            if self.action == _current_menu:
+                TUI += f"{self.DEFAULT_SPACE}\033[34m> {menu["name"]}\033[0m\n"
+            else:
+                TUI += f"{self.DEFAULT_SPACE}> {menu["name"]}\033[0m\n"
+
+            TUI += "\n"
+            _current_menu += 1
+
+        if len(self._menus) == self._max_menus:
+            self._max_menus += 1 #? add Exit menu in UI
+        
+        if self.action == self._max_menus: #? exit menu always is last
+            TUI += f"{self.DEFAULT_SPACE}\033[31m> Exit\033[0m\n"
+        else:
+            TUI += f"{self.DEFAULT_SPACE}> Exit\033[0m\n"
+
+        TUI += "\n" + self.FOOTER + "\n"
+
+        sys.stdout.write("\033[H") #? set cursor to pos (0, 0)
+        sys.stdout.write(TUI)
+        sys.stdout.flush()
+
+    def addMenu(self, name: str, callback):
+        """
+        Adding menu to UI.
+
+        Args:
+            name (str): name of the menu
+            callback: what need to call, when menu selected
+        """
+        try:
+            self._menus.append({
+                "name": name,
+                "callback": callback
+            })
+            self._max_menus += 1
+        except Exception as e:
+            raise Exception(e)
+
+    def Run(self):
+        if len(self._menus) < 1:
+            raise ValueError("UI can't has been created without menus")
+        
+        try:
+            self._clearTerminal()
+            self.UpdateUI()
+            while True:
+                if self._requestClosing:
+                    sys.exit()
+                    break
+                else:
+                    pass
+        
+        except KeyboardInterrupt:
+            sys.stdout.write("[!] Exited by user\n")
+            sys.stdout.flush()
+
+        except Exception as e:
+            raise Exception(e)

ttykit-0.3.5/src/ttykit/console/console.py

@@ -0,0 +1,235 @@
+import sys
+import os
+from typing import Optional, Literal, Mapping, Any
+from ttykit import Colors, Styles
+
+from .const import ColorSystem, WINDOWS
+
+class Console:
+    """
+    Class for controling terminal events
+
+    Args:
+        color_system (str, Optional): Color system of the terminal. Either `standard`, `256` or `truecolor`. Leave as `auto` to autodetect.
+        width (int): width of the terminal. If state is `None`, calculates it automatically.
+        height (int): height of the terminal. If state is `None`, calculates it automatically.
+        stderr (bool): use `stderr` for errors instead of stdout. Default `False`.
+        no_color (bool): if `True`, the terminal be without colors, only monochrome (white and black). Default `False`.
+        force_terminal (bool): if `True` use terminal control codes in any situation.
+    """
+
+    _environ: Mapping[str, str] = os.environ
+
+    def __init__(self, 
+        color_system: Optional[Literal["auto", "standard", "256", "truecolor", "windows"]] = "auto", 
+        width: int = None, 
+        height: int = None,
+        stderr: bool = False,
+        no_color: bool = False,
+        force_terminal: Optional[bool] = False
+    ):
+        super().__init__()
+
+        #? preparing to avoid any errors
+        self._color_system = Optional[ColorSystem]
+        self._force_terminal = None
+        self.stderr = stderr
+        self.no_color = no_color
+        self.height = None
+        self.width = None
+
+        if color_system is None:
+            self._color_system = None
+        elif color_system == "auto":
+            self._color_system =  self._detect_colorSystem()
+
+        if force_terminal is not None:
+            self._force_terminal = force_terminal
+
+        if width is None:
+            try:
+                size = os.get_terminal_size()
+                width = size.columns
+            except OSError:
+                print('Error calculating width of the terminal. Use default value (80)')
+                width = 80
+
+        if height is None:
+            try:
+                size = os.get_terminal_size()
+                height = size.lines
+            except OSError:
+                print('Error calculating height of the terminal. Use default value (24)')
+                height
+
+    def _print_error(self, msg: str=None):
+        if msg is None:
+            return
+
+        if self.stderr:
+            sys.stderr.write(msg)
+
+    @property
+    def isTerminal(self) -> bool:
+        """
+        Check if the console writing to a terminal
+
+        Returns:
+            state (bool): return `True` if console is understanding escape sequences, otherwise `False`
+        """
+        if self._force_terminal is not None:
+            return True
+
+        if hasattr(sys.stdin, "__module__") and sys.stdin.__module__.startswith("idlelib"):
+            return False #? return False for idle which claims to be a tty but can't handle ANSI codes
+
+        ttyCompatyble = self._environ.get('TTY_COMPATIBLE', '')
+        if ttyCompatyble == '0': #? 0 = device is not tty compatible
+            return False
+        elif ttyCompatyble =='1': #? 1 = device is tty compatible
+            return True
+
+        if not sys.stdout.isatty():
+            return False
+
+
+    @property
+    def is_dumb_terminal(self) -> bool:
+        """Detect dumb terminal.
+    
+        Returns:
+            state (bool): `True` if writing to a dumb terminal, otherwise `False`.
+
+        """
+        is_dumb = self._environ.get("TERM", "").lower() in ("dumb", "unknown")
+        return self.isTerminal and is_dumb
+
+
+    @property
+    def color_system(self):
+        return self._detect_colorSystem()
+
+
+    def _detect_colorSystem(self) -> Optional[ColorSystem]:
+        """Autodetect the supported color theme fo the terminal"""
+
+        if self.no_color:
+            return None
+
+        if WINDOWS:
+            # TODO: add check for legacy windows
+            
+            if self._environ.get('COLORTERM') in ('truecolor', '24bit'):
+                return ColorSystem.TRUECOLOR
+            return ColorSystem.WINDOWS
+        else:
+            if self._environ.get('COLORTERM') in ('truecolor', '24bit'):
+                return ColorSystem.TRUECOLOR
+            
+            if self._environ.get("TERM") in ("xterm-256color", "screen-256color"):
+                return ColorSystem.EIGHT_BIT
+            return ColorSystem.STANDARD
+
+    def _get_style_code(self, style: str) -> str:
+        styles = {
+            'bold': Styles.BOLD,
+            'dim': Styles.DIM,
+            'italic': Styles.ITALIC,
+            'underline': Styles.UNDERLINE,
+            'blink': Styles.BLINK,
+            'rapid_blink': Styles.RAPID_BLINK,
+            'reverse': Styles.REVERSE
+        }
+        return styles.get(style, '')
+
+    def _get_color_code(self, color: str) -> str:
+        colors = {
+            "black": Colors.BLACK,
+            "red": Colors.RED,
+            "green": Colors.GREEN,
+            "yellow": Colors.YELLOW,
+            "blue": Colors.BLUE,
+            "purple": Colors.PURPLE,
+            "cyan": Colors.CYAN,
+            "white": Colors.WHITE,
+            "dark_grey": Colors.DARK_GREY,
+            "light_red": Colors.LIGHT_RED,
+            "light_green": Colors.LIGHT_GREEN,
+            "light_yellow": Colors.LIGHT_YELLOW,
+            "light_blue": Colors.LIGHT_BLUE,
+            "light_purple": Colors.LIGHT_PURPLE,
+            "light_cyan": Colors.LIGHT_CYAN,
+            "light_white": Colors.LIGHT_WHITE
+        }
+        return colors.get(color, "")
+
+    def bell(self):
+        sys.stdout.write("\a")
+        sys.stdout.flush()
+
+    def print(self,
+            *args,
+            sep: str | None=" ",
+            end: str | None ="\n",
+            style: str | None=None,
+            color: str | None=None) -> None:
+        """
+        Print the args to a stream
+
+        Args:
+            *args (Any): args to write to a stream
+            sep (str | None): string inserted between values, default a space.
+            end (str | None): string appended after the last value, default a newline.
+            style: style of args write to a steam, default `None`.
+            color: color of args write to a stream, default `None`.
+        Returns:
+            None: write in `stdout`
+        """
+        if not self.isTerminal or self.no_color:
+            #? Just out, without colors or styles
+            sys.stdout.write(sep.join(str(a) for a in args) + end)
+            return
+
+        #TODO: realize print logic with color style replace
+        
+        #? Apply the style with color to args
+        text = sep.join(str(a) for a in args)
+        if color and self.color_system:
+            color_code = self._get_color_code(color.lower())
+            text = f"{color_code}{text}{Colors.RESET}"
+
+        if style:
+            style_code = self._get_style_code(style.lower())
+            text = f"{style_code}{text}"
+
+        sys.stdout.write(text + end)
+        sys.stdout.flush()
+
+
+    def input(self,
+            prompt = '',
+            *,
+            style: str | None = None,
+            color: str | None = None,
+            password: bool = False) -> str:
+        """
+        Displays a prompt if have and waits for input from user.
+
+        Args:
+            prompt: text to render in prompt
+            style (str | None): style for prompt render. Required prompt
+            color (str | None): color for prompt render. Required prompt
+            password (bool): if `True`, hide typed text. Default `False`
+        Returns:
+            result (str): typed text from user from stdin
+        """
+
+        if prompt:
+            self.print(prompt, style=style, color=color, end='')
+
+        if password:
+            # TODO: realize text hidding
+            Warning("This attribute in developing. Please, set 'password=False'")
+        else:
+            result = input()
+        return result

ttykit-0.3.5/src/ttykit/console/const.py

@@ -0,0 +1,18 @@
+from enum import IntEnum
+import sys
+
+WINDOWS = sys.platform == "win32"
+
+class ColorSystem(IntEnum):
+    """One of the 3 color system supported by terminals."""
+
+    STANDARD = 1
+    EIGHT_BIT = 2
+    TRUECOLOR = 3
+    WINDOWS = 4
+
+    def __repr__(self) -> str:
+        return f"ColorSystem.{self.name}"
+
+    def __str__(self) -> str:
+        return repr(self)

{ttykit-0.2.2 → ttykit-0.3.5/src/ttykit.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: ttykit
-Version: 0.2.2
+Version: 0.3.5
 Summary: Helping made beatiful out in terminal
 Author: He-STALIN
 Author-email: hene.stalin@gmail.com
@@ -32,6 +32,7 @@ Keywords: tty,terminal,formatting
 Requires-Python: >=3.13
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: keyboard
 Provides-Extra: test
 Requires-Dist: pytest; extra == "test"
 Dynamic: license-file
@@ -47,18 +48,23 @@ Dynamic: license-file
 [![Repository](https://img.shields.io/badge/Repository-GitHub-4b93ff?style=flat&logo=github&logoColor=white)](https://github.com/He-STALIN/ttykit)
 
 </div>
+
 ---
 
 ## 📦 For Start
+### Manually:
 
 ```bash
 git clone https://github.com/He-STALIN/ttykit.git
 ```
 
 - Change dir and exec
+
 ```bash
 pip install .
 ```
+### Auto
+- exec `pip install ttykit`
 
 - And use in your projects!
 

{ttykit-0.2.2 → ttykit-0.3.5}/src/ttykit.egg-info/SOURCES.txt

@@ -11,4 +11,7 @@ src/ttykit.egg-info/SOURCES.txt
 src/ttykit.egg-info/dependency_links.txt
 src/ttykit.egg-info/entry_points.txt
 src/ttykit.egg-info/requires.txt
-src/ttykit.egg-info/top_level.txt
+src/ttykit.egg-info/top_level.txt
+src/ttykit/console/TUI.py
+src/ttykit/console/console.py
+src/ttykit/console/const.py

{ttykit-0.2.2 → ttykit-0.3.5}/src/ttykit.egg-info/requires.txt

@@ -1,3 +1,4 @@
+keyboard
 
 [test]
 pytest

ttykit-0.2.2/src/ttykit/__init__.py

@@ -1,22 +0,0 @@
-"""Helping made beatiful out in terminal"""
-
-from .progress import Progress
-from .status import Status
-from ._state import TaskState, Colors, Styles, RESET
-
-__colors__ = [
-    Colors,
-    Styles,
-    RESET
-]
-
-__all__ = [
-    'Progress',
-    'Status',
-    'TaskState'
-]
-
-__name__ = 'ttykit'
-__author__ = 'He-STALIN'
-__version__ = '0.2.2'
-__license__ = 'MIT'