ttykit 0.4.0__tar.gz → 0.5.0__tar.gz

ttykit-0.5.0/PKG-INFO

@@ -0,0 +1,189 @@
+Metadata-Version: 2.4
+Name: ttykit
+Version: 0.5.0
+Summary: Helping made beatiful out in terminal
+Author: He-STALIN
+Author-email: hene.stalin@gmail.com
+License: MIT License
+        
+        Copyright (c) 2026 _STALIN_
+        
+        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.
+        
+Project-URL: Homepage, https://github.com/He-STALIN/ttykit
+Project-URL: BugTracker, https://github.com/He-STALIN/ttykit/issues
+Keywords: tty,terminal,formatting
+Requires-Python: >=3.13
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Provides-Extra: test
+Requires-Dist: pytest; extra == "test"
+Dynamic: license-file
+
+<div align="center">
+
+# TTYKit
+
+> **Helping made beautiful out in terminal**
+
+[![Python Version](https://img.shields.io/badge/python-3.13+-blue.svg)](https://python.org)
+[![GitHub license](https://img.shields.io/github/license/He-STALIN/ttykit)](https://github.com/He-STALIN/ttykit/blob/main/LICENSE)
+[![Repository](https://img.shields.io/badge/Repository-GitHub-4b93ff?style=flat&logo=github&logoColor=white)](https://github.com/He-STALIN/ttykit)
+[![Downloads](https://img.shields.io/pypi/dm/ttykit)](https://pypi.org/project/ttykit/)
+
+</div>
+
+## This file is 2-lang
+- [EN Version](#en)
+- [RU Версия](#ru)
+
+
+## EN
+### For Start
+- #### Automatic
+    - exec `pip install ttykit`
+
+- #### Manually
+    - #### Dev version
+        - clone repository
+            ```bash
+            git clone https://github.com/He-STALIN/ttykit.git
+            ```
+
+        - change to dir and exec
+            ```bash
+            pip install .
+            ```
+
+    - #### From Release
+        - download any release from [Releases](https://github.com/He-STALIN/ttykit/releases)
+
+        - exec in terminal
+            ```bash
+            pip install <path>
+            ```
+            where `<path>` you need write path to the downloaded release file
+
+### support the project
+- If you would like the project to continue developing, you can make a [donation](https://yoomoney.ru/to/4100118618732284/100).
+- Account: `4100 1186 1873 2284` (YouMoney)
+- or
+- Find bugs in the library and report them in the [`issues` section on GitHub](https://github.com/He-STALIN/ttykit/issues).
+
+### Code Examples
+- #### Status
+    ```python
+    from ttykit import Status, TaskState
+
+    with Status("Something unit", spinner="line") as status:
+        ... # your payload
+        status.set_state(TaskState.SUCCESS)
+    ```
+
+- #### Progress
+    ```python
+    from ttykit import Progress
+
+    with Progress(100, "Some desc", 40) as progress:
+        ... # your code
+        progress.update(value)
+        ... # your code again
+        progress.finish()
+    ```
+
+- **for more code examples see** [CODE USE](https://github.com/He-STALIN/ttykit/blob/main/docs/en/CODE_USE.md)
+
+
+### License
+- This lib uploading with MIT License. [See License](https://github.com/He-STALIN/ttykit/blob/main/LICENSE)
+
+### Versions
+- You interesting see versions? You can see [CHANGELOG](https://github.com/He-STALIN/ttykit/blob/main/docs/en/CHANGELOG.md)
+
+
+## RU
+### Для начала использования
+- #### Авто-установка
+    - выполните `pip install ttykit` в терминале
+
+- #### Вручную
+    - #### Разрабатываемую версию
+        - скопируйте репозиторий
+            ```bash
+            git clone https://github.com/He-STALIN/ttykit.git
+            ```
+
+        - перейдите в папку и выполни
+            ```bash
+            pip install .
+            ```
+    - #### Релизную версию
+        - Скачайте любой релиз из вкладки ["Releases"](https://github.com/He-STALIN/ttykit/releases)
+
+        - выполните в терминале
+            ```bash
+            pip install <path>
+            ```
+            Где `<path>` вам нужно вставить путь к скачанному файлу релиза
+
+
+### Поддержите проект
+- Если вы желаете, чтобы проект разрабатывался дальше, вы можете сделать [пожертвование](https://yoomoney.ru/to/4100118618732284/100).
+- Счет: `4100 1186 1873 2284` (ЮМани)
+- или
+- Ищите ошибки в библиотеке и сообщайте о них в [`issues` на GitHub](https://github.com/He-STALIN/ttykit/issues).
+
+
+### Примеры кода
+- #### Status класс
+    ```python
+    from ttykit import Status, TaskState
+
+    with Status("Какая-то задача", spinner="line") as status:
+        ... # ваша нагрузка
+        status.set_state(TaskState.SUCCESS)
+    ```
+
+- #### Progress класс
+    ```python
+    from ttykit import Progress
+
+    with Progress(100, "Некоторое описание", 40) as progress:
+        ... # ваш код
+        progress.update(value)
+        ... # и снова ваш код
+        progress.finish()
+    ```
+
+- **Для большего количества примеров и описания смотрите** [CODE USE](https://github.com/He-STALIN/ttykit/blob/main/docs/ru/CODE_USE.md)
+
+
+### Лицензия
+- Это библиотека распространяется под лицензией MIT. [Смотреть лицензию](https://github.com/He-STALIN/ttykit/blob/main/LICENSE)
+
+### Версии
+- вам интересно узнать про версии? Вы можете посмотреть [CHANGELOG](https://github.com/He-STALIN/ttykit/blob/main/docs/ru/CHANGELOG.md)
+
+
+---
+<div align="center">
+
+*ttykit by He_STALIN. All rights reserved*
+
+</div>

ttykit-0.5.0/README.pypi.md

@@ -0,0 +1,151 @@
+<div align="center">
+
+# TTYKit
+
+> **Helping made beautiful out in terminal**
+
+[![Python Version](https://img.shields.io/badge/python-3.13+-blue.svg)](https://python.org)
+[![GitHub license](https://img.shields.io/github/license/He-STALIN/ttykit)](https://github.com/He-STALIN/ttykit/blob/main/LICENSE)
+[![Repository](https://img.shields.io/badge/Repository-GitHub-4b93ff?style=flat&logo=github&logoColor=white)](https://github.com/He-STALIN/ttykit)
+[![Downloads](https://img.shields.io/pypi/dm/ttykit)](https://pypi.org/project/ttykit/)
+
+</div>
+
+## This file is 2-lang
+- [EN Version](#en)
+- [RU Версия](#ru)
+
+
+## EN
+### For Start
+- #### Automatic
+    - exec `pip install ttykit`
+
+- #### Manually
+    - #### Dev version
+        - clone repository
+            ```bash
+            git clone https://github.com/He-STALIN/ttykit.git
+            ```
+
+        - change to dir and exec
+            ```bash
+            pip install .
+            ```
+
+    - #### From Release
+        - download any release from [Releases](https://github.com/He-STALIN/ttykit/releases)
+
+        - exec in terminal
+            ```bash
+            pip install <path>
+            ```
+            where `<path>` you need write path to the downloaded release file
+
+### support the project
+- If you would like the project to continue developing, you can make a [donation](https://yoomoney.ru/to/4100118618732284/100).
+- Account: `4100 1186 1873 2284` (YouMoney)
+- or
+- Find bugs in the library and report them in the [`issues` section on GitHub](https://github.com/He-STALIN/ttykit/issues).
+
+### Code Examples
+- #### Status
+    ```python
+    from ttykit import Status, TaskState
+
+    with Status("Something unit", spinner="line") as status:
+        ... # your payload
+        status.set_state(TaskState.SUCCESS)
+    ```
+
+- #### Progress
+    ```python
+    from ttykit import Progress
+
+    with Progress(100, "Some desc", 40) as progress:
+        ... # your code
+        progress.update(value)
+        ... # your code again
+        progress.finish()
+    ```
+
+- **for more code examples see** [CODE USE](https://github.com/He-STALIN/ttykit/blob/main/docs/en/CODE_USE.md)
+
+
+### License
+- This lib uploading with MIT License. [See License](https://github.com/He-STALIN/ttykit/blob/main/LICENSE)
+
+### Versions
+- You interesting see versions? You can see [CHANGELOG](https://github.com/He-STALIN/ttykit/blob/main/docs/en/CHANGELOG.md)
+
+
+## RU
+### Для начала использования
+- #### Авто-установка
+    - выполните `pip install ttykit` в терминале
+
+- #### Вручную
+    - #### Разрабатываемую версию
+        - скопируйте репозиторий
+            ```bash
+            git clone https://github.com/He-STALIN/ttykit.git
+            ```
+
+        - перейдите в папку и выполни
+            ```bash
+            pip install .
+            ```
+    - #### Релизную версию
+        - Скачайте любой релиз из вкладки ["Releases"](https://github.com/He-STALIN/ttykit/releases)
+
+        - выполните в терминале
+            ```bash
+            pip install <path>
+            ```
+            Где `<path>` вам нужно вставить путь к скачанному файлу релиза
+
+
+### Поддержите проект
+- Если вы желаете, чтобы проект разрабатывался дальше, вы можете сделать [пожертвование](https://yoomoney.ru/to/4100118618732284/100).
+- Счет: `4100 1186 1873 2284` (ЮМани)
+- или
+- Ищите ошибки в библиотеке и сообщайте о них в [`issues` на GitHub](https://github.com/He-STALIN/ttykit/issues).
+
+
+### Примеры кода
+- #### Status класс
+    ```python
+    from ttykit import Status, TaskState
+
+    with Status("Какая-то задача", spinner="line") as status:
+        ... # ваша нагрузка
+        status.set_state(TaskState.SUCCESS)
+    ```
+
+- #### Progress класс
+    ```python
+    from ttykit import Progress
+
+    with Progress(100, "Некоторое описание", 40) as progress:
+        ... # ваш код
+        progress.update(value)
+        ... # и снова ваш код
+        progress.finish()
+    ```
+
+- **Для большего количества примеров и описания смотрите** [CODE USE](https://github.com/He-STALIN/ttykit/blob/main/docs/ru/CODE_USE.md)
+
+
+### Лицензия
+- Это библиотека распространяется под лицензией MIT. [Смотреть лицензию](https://github.com/He-STALIN/ttykit/blob/main/LICENSE)
+
+### Версии
+- вам интересно узнать про версии? Вы можете посмотреть [CHANGELOG](https://github.com/He-STALIN/ttykit/blob/main/docs/ru/CHANGELOG.md)
+
+
+---
+<div align="center">
+
+*ttykit by He_STALIN. All rights reserved*
+
+</div>

{ttykit-0.4.0 → ttykit-0.5.0}/pyproject.toml

@@ -8,7 +8,7 @@ include = ["ttykit*"]
 
 [project]
 name = "ttykit"
-version = "0.4.0"
+version = "0.5.0"
 description = "Helping made beatiful out in terminal"
 requires-python = ">=3.13"
 authors = [
@@ -16,12 +16,13 @@ authors = [
     {email = "hene.stalin@gmail.com"}
     ]
 license = {file = "LICENSE"}
-readme = "README.md"
+readme = "README.pypi.md"
 keywords = ['tty', 'terminal', 'formatting']
-dependencies = ["keyboard"]
+dependencies = []
 
 [project.scripts]
 ttykit-spinner = "ttykit.examples.spinner:main"
+ttykit-progressbar = "ttykit.examples.progressbar:main"
 
 [project.optional-dependencies]
 test = ["pytest"]

ttykit-0.5.0/src/ttykit/__init__.py

@@ -0,0 +1,65 @@
+"""
+        ttykit
+=-=-=-=-=-=-=-=-=-=-=-
+Helps produce attractive terminal output.
+
+Author: He-STALIN
+License: MIT License
+
+Available imports:
+    ├─ Classes:
+    │     + Progress
+    │     + Status
+    │     + Tree
+    │     + Console
+    ├─ Submodules:
+    │     + data
+    │     - Input
+    │     + utils
+    ├─ Methods:
+    │     + get_console
+    └─ In dev/un-ready:
+        - TUI (class)
+        - Input (submodule)
+
+Documentation you can see here:
+    https://github.com/He-STALIN/ttykit/tree/main/docs
+"""
+
+from .console.console import Console
+from .console import input as Input
+from .progress import Progress
+from .console.TUI import TUI
+from .status import Status
+from .tree import Tree
+from . import data, utils
+
+
+__all__ = [
+    'Progress',
+    'Status',
+    'data',
+    'Console',
+    'Tree',
+    'TUI',
+    "Input",
+    'get_console',
+    'utils'
+]
+
+__name__ = 'ttykit'
+__author__ = 'He-STALIN'
+__version__ = '0.5.0'
+__license__ = 'MIT'
+
+
+console_inst: "Console" = None
+
+def get_console() -> 'Console':
+    """Return a instance of `Console`"""
+    global console_inst
+    if console_inst:
+        return console_inst
+    else:
+        console_inst = Console()
+        return console_inst

{ttykit-0.4.0 → ttykit-0.5.0}/src/ttykit/console/TUI.py

@@ -1,4 +1,5 @@
-import keyboard as kb
+from ttykit import Input as kb
+from warnings import warn
 import os, sys
 
 
@@ -42,7 +43,7 @@ class TUI:
     def __init__(self, title: str):
         super().__init__()
 
-        print("[WARNING] Class 'TUI' not fully completed and may contain errors.")
+        warn("This class is not actually an interface and will be removed when a full-fledged TUI composer is created.", FutureWarning, stacklevel=2)
 
         self.TITLE: str = title if title else "Text UI"
         self.FOOTER: str = "For control use arrows Up/Down and Enter to select"

{ttykit-0.4.0 → ttykit-0.5.0}/src/ttykit/console/console.py

@@ -1,10 +1,11 @@
-import sys
-import os
 from typing import Optional, Literal, Mapping
-from ttykit.segmentation import Segmentation
 from getpass import getpass
+import warnings
+import sys
+import os
 
-from .const import ColorSystem, WINDOWS
+from ttykit.data.const import ColorSystem, WINDOWS
+from ttykit.segmentation import Segmentation
 
 class Console:
     """
@@ -52,7 +53,7 @@ class Console:
                 size = os.get_terminal_size()
                 self.width = size.columns
             except OSError:
-                print('Error calculating width of the terminal. Use default value (80)')
+                warnings.warn('Error calculating width of the terminal. Use default value (80)', UserWarning)
                 self.width = 80
 
         if self.height is None:
@@ -60,8 +61,8 @@ class Console:
                 size = os.get_terminal_size()
                 self.height = size.lines
             except OSError:
-                print('Error calculating height of the terminal. Use default value (24)')
-                self.height
+                warnings.warn('Error calculating height of the terminal. Use default value (24)', UserWarning)
+                self.height = 24
 
     def _print_error(self, msg: str=None):
         if msg is None:
@@ -69,6 +70,10 @@ class Console:
 
         if self.stderr:
             sys.stderr.write(msg)
+        else:
+            sys.stdout.write(msg)
+
+        sys.stdout.flush()
 
     @property
     def isTerminal(self) -> bool:
@@ -78,16 +83,16 @@ class Console:
         Returns:
             state (bool): return `True` if console is understanding escape sequences, otherwise `False`
         """
-        if self._force_terminal is not None:
+        if self._force_terminal not in [None, False]:
             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
+        ttyCompatible = self._environ.get('TTY_COMPATIBLE', '')
+        if ttyCompatible == '0': #? 0 = device is not tty compatible
             return False
-        elif ttyCompatyble =='1': #? 1 = device is tty compatible
+        elif ttyCompatible =='1': #? 1 = device is tty compatible
             return True
 
         if not sys.stdout.isatty():
@@ -132,14 +137,14 @@ class Console:
             return ColorSystem.STANDARD
 
     def bell(self):
-        sys.stdout.write("\a")
+        sys.stdout.write("\x07")
         sys.stdout.flush()
 
     def print(self,
             *args,
             sep: Optional[str] =" ",
             end: Optional[str] ="\n",
-            justify: str = "left",
+            justify: Literal["left", "center", "right"] = "left",
             fillchar: str = " "
             ) -> None:
         """
@@ -159,7 +164,7 @@ class Console:
                 print("[blue] This is test string")
 
             output:
-                <div style="color: blue;"> This is test string</div>
+                This is test string
         """
         if not self.isTerminal or self.no_color:
             #? Just out, without colors or styles
@@ -207,8 +212,45 @@ class Console:
             self.print(prompt, end='', justify=justify, fillchar=fillchar)
 
         if password:
-            # TODO: realize text hidding
             result = getpass(prompt='')
         else:
             result = input()
-        return result
+        return result
+
+    def set_cursor(self, width: int, height: int):
+        """Set terminal cursor to coordinates"""
+        if not type(width) == int:
+            raise TypeError(f"Argument 'width' can be only 'int', not be {type(width)}")
+        if not type(height) == int:
+            raise TypeError(f"Argument 'height' can be only 'int', not be {type(height)}")
+
+        if width > self.width:
+            raise ValueError(f"Argument 'width' cannot exceed the terminal width, but '{width}' was received")
+
+        if height > self.height:
+            raise ValueError(f"Argument 'height' cannot exceed the terminal height, but '{height}' was received")
+
+        sys.stdout.write(f'\x1b[{height};{width}H')
+        sys.stdout.flush()
+
+    def set_alt_screen(self, enable: bool = True):
+        """Set alternative screen of terminal"""
+        if self.isTerminal:
+            if enable:
+                sys.stdout.write('\x1b[?1049h') #? high - enable
+                sys.stdout.flush()
+            else:
+                sys.stdout.write('\x1b[?1049l') #? low - disable
+                sys.stdout.flush()
+
+    def set_window_title(self, title: str):
+        """Sets the window title
+        
+        Warning: some terminal (ex. `fish`) reset title before and after command executing"""
+
+        if not type(title) == str:
+            raise TypeError(f"Argument 'title' must be type of 'str'")
+
+        if self.isTerminal:
+            sys.stdout.write(f"\x1b]0;{title}\x07")
+            sys.stdout.flush()

ttykit-0.5.0/src/ttykit/console/input/__init__.py

@@ -0,0 +1,90 @@
+from typing import Callable as _Callable
+import platform as _platform
+from warnings import warn
+
+from ._local import str_to_KeyEvent, KeyEvent_to_str
+from ttykit.utils import InputWarning, SupportError, SupportWarning
+from ttykit.data import KeyEvent as _KeyEvent
+
+if _platform.system() == "Windows":
+    from ._windows import WindowsKeyboard as _Keyboard
+elif _platform.system() == "Linux":
+    from ._unix import UnixKeyboard as _Keyboard
+    warn(
+        "Unix-related keyboard reader not fully made and may contain critical bugs",
+        InputWarning,
+        stacklevel=2
+    )
+# elif _platform.system() == "Darwin":
+else:
+    raise SupportError(f"Unsupported operating system: {_platform.system()}")
+
+try:
+    import IPython
+    warn("Submodule Input can don't work on IPython", SupportWarning)
+except ImportError:
+    pass
+
+_kb = None
+
+def add_hotkey(hotkey: str | _KeyEvent, callback: _Callable) -> None:
+    """Adds a hotkey that executes when pressed
+    
+    Args:
+        hotkey (str | KeyEvent):
+            Hotkey to which the call will be linked
+        callback (Callable):
+            The method that will be called
+    """
+    _get_kb().add_hotkey(hotkey=hotkey, callback=callback)
+
+
+def send(hotkey: str | _KeyEvent) -> None:
+    """Send hotkey press and release"""
+    _get_kb().send(hotkey)
+
+
+def release(hotkey: str | _KeyEvent) -> None:
+    """Release pressed key"""
+    _get_kb().release(hotkey)
+
+
+def press(hotkey: str | _KeyEvent) -> None:
+    """presses and holds the key"""
+    _get_kb().press(hotkey)
+
+
+def get_key() -> "_KeyEvent":
+    """Returns the pressed key"""
+    return _get_kb().get_key()
+
+
+def clear_all_hotkeys() -> None:
+    """Reset all configured hotkeys"""
+    _get_kb().clear_all_hotkeys()
+
+
+def clear_hotkey(hotkey: str | _KeyEvent) -> None:
+    """Reset configured hotkey"""
+    _get_kb().clear_hotkey(hotkey)
+
+
+def _get_kb():
+    global _kb
+    if _kb is None:
+        _kb = _Keyboard()
+        return _kb
+    else:
+        return _kb
+
+__all__ = [
+    'add_hotkey',
+    'send',
+    'release',
+    'press',
+    'get_key',
+    'clear_all_hotkeys',
+    'clear_hotkey',
+    'str_to_KeyEvent',
+    'KeyEvent_to_str'
+]