tuiro 0.1.0__tar.gz

tuiro-0.1.0/PKG-INFO

@@ -0,0 +1,202 @@
+Metadata-Version: 2.3
+Name: tuiro
+Version: 0.1.0
+Summary: Tiny terminal UI utility for clean, colorful build output.
+Keywords: terminal,tui,ansi,cli,colors,logging,build-tools
+Author: NellowTCS
+Author-email: NellowTCS <nellowtcs@gmail.com>
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Operating System :: OS Independent
+Classifier: Environment :: Console
+Classifier: Topic :: Terminals
+Classifier: Topic :: Software Development :: Build Tools
+Classifier: Topic :: Utilities
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+
+# tuiro
+
+tuiro is a tiny terminal UI helper designed for clean, readable, and structured output in build scripts and command‑line tools. It provides simple utilities for sections, banners, status messages, command logging, and themed output without introducing heavy dependencies or complex abstractions.
+
+> tuiro began as an internal utility inside the TactileBrowser project (https://github.com/NellowTCS/TactileBrowser). It is now available as a standalone library for any script or tool that wants clear and consistent terminal output.
+
+## Features
+
+- Lightweight and dependency‑free
+- ANSI color support with optional CI mode
+- Built‑in themes and user‑defined palettes
+- Section and subsection headers
+- Informational, warning, success, and error messages
+- Command logging for build steps
+- Centered banners with automatic terminal width detection
+- A simple step context manager for build phases
+- A minimal CLI for quick verification and theme testing
+
+## Installation
+
+```
+pip install tuiro
+```
+
+For development:
+
+```
+uv pip install -e .
+```
+
+## Usage
+
+Basic example:
+
+```python
+from tuiro import TUI
+
+tui = TUI()
+tui.banner("Build")
+tui.section("Environment")
+tui.info("Checking dependencies")
+tui.success("All checks passed")
+```
+
+Example output (colors omitted):
+
+```
+╔══════════════════════════════════════════════════════════╗
+║                          Build                           ║
+╚══════════════════════════════════════════════════════════╝
+
+────────────────────────────────────────────────────────────
+  Environment
+────────────────────────────────────────────────────────────
+[*] Checking dependencies
+[OK] All checks passed
+```
+
+## Themes
+
+tuiro supports both built‑in themes and user‑defined palettes.
+
+### Built‑in themes
+
+- default  
+- mono  
+- pastel  
+
+Use a theme by name:
+
+```python
+tui = TUI(theme="pastel")
+```
+
+### Custom palettes
+
+Palettes live in `tuiro.palette`. Users can define their own palette by subclassing `Palette`:
+
+```python
+from tuiro.palette import Palette
+from tuiro.colors import Colors
+
+class MyPalette(Palette):
+    success = Colors.BRIGHT_GREEN
+    info = Colors.BRIGHT_CYAN
+```
+
+Then pass it to TUI:
+
+```python
+tui = TUI(theme=MyPalette)
+```
+
+or:
+
+```python
+tui = TUI(theme=MyPalette())
+```
+
+Note: The CLI `--theme` flag accepts only built‑in theme names from `PROFILES`. Custom palettes must be provided from Python code.
+
+## CLI
+
+tuiro includes a small demonstration CLI:
+
+```
+tuiro
+```
+
+Flags:
+
+```
+tuiro --ci
+tuiro --no-color
+tuiro --theme pastel
+tuiro --help
+tuiro --version
+```
+
+Behavior:
+
+- `--ci` disables colors
+- `--no-color` also disables colors
+- If both are provided, colors remain disabled
+- `--theme NAME` selects a built‑in theme
+- `--help` lists available themes
+
+Example:
+
+```
+tuiro --ci --theme mono
+```
+
+## API
+
+### `TUI(ci_mode: bool = False, theme: str | Palette = "default")`
+
+Creates a new terminal UI helper.
+
+### `section(title: str)`
+
+Prints a high‑visibility section header.
+
+### `subsection(title: str)`
+
+Prints a smaller subsection header.
+
+### `banner(title: str)`
+
+Prints a centered banner.
+
+### Status messages
+
+```
+info(message: str)
+success(message: str)
+warning(message: str)
+error(message: str)
+```
+
+### `command(cmd: str | list[str])`
+
+Prints a command being executed. Lists are joined with spaces.
+
+### `result(label: str, value: str)`
+
+Prints a key‑value result line.
+
+### `table(rows: list[tuple[str, str]])`
+
+Prints a simple two‑column table aligned on the left column.
+
+### `step(title: str)`
+
+Context manager for build steps:
+
+```python
+with tui.step("Compiling"):
+    run_compiler()
+```
+
+## License
+
+MIT License. See (LICENSE)[LICENSE] for details.

tuiro-0.1.0/README.md

@@ -0,0 +1,184 @@
+# tuiro
+
+tuiro is a tiny terminal UI helper designed for clean, readable, and structured output in build scripts and command‑line tools. It provides simple utilities for sections, banners, status messages, command logging, and themed output without introducing heavy dependencies or complex abstractions.
+
+> tuiro began as an internal utility inside the TactileBrowser project (https://github.com/NellowTCS/TactileBrowser). It is now available as a standalone library for any script or tool that wants clear and consistent terminal output.
+
+## Features
+
+- Lightweight and dependency‑free
+- ANSI color support with optional CI mode
+- Built‑in themes and user‑defined palettes
+- Section and subsection headers
+- Informational, warning, success, and error messages
+- Command logging for build steps
+- Centered banners with automatic terminal width detection
+- A simple step context manager for build phases
+- A minimal CLI for quick verification and theme testing
+
+## Installation
+
+```
+pip install tuiro
+```
+
+For development:
+
+```
+uv pip install -e .
+```
+
+## Usage
+
+Basic example:
+
+```python
+from tuiro import TUI
+
+tui = TUI()
+tui.banner("Build")
+tui.section("Environment")
+tui.info("Checking dependencies")
+tui.success("All checks passed")
+```
+
+Example output (colors omitted):
+
+```
+╔══════════════════════════════════════════════════════════╗
+║                          Build                           ║
+╚══════════════════════════════════════════════════════════╝
+
+────────────────────────────────────────────────────────────
+  Environment
+────────────────────────────────────────────────────────────
+[*] Checking dependencies
+[OK] All checks passed
+```
+
+## Themes
+
+tuiro supports both built‑in themes and user‑defined palettes.
+
+### Built‑in themes
+
+- default  
+- mono  
+- pastel  
+
+Use a theme by name:
+
+```python
+tui = TUI(theme="pastel")
+```
+
+### Custom palettes
+
+Palettes live in `tuiro.palette`. Users can define their own palette by subclassing `Palette`:
+
+```python
+from tuiro.palette import Palette
+from tuiro.colors import Colors
+
+class MyPalette(Palette):
+    success = Colors.BRIGHT_GREEN
+    info = Colors.BRIGHT_CYAN
+```
+
+Then pass it to TUI:
+
+```python
+tui = TUI(theme=MyPalette)
+```
+
+or:
+
+```python
+tui = TUI(theme=MyPalette())
+```
+
+Note: The CLI `--theme` flag accepts only built‑in theme names from `PROFILES`. Custom palettes must be provided from Python code.
+
+## CLI
+
+tuiro includes a small demonstration CLI:
+
+```
+tuiro
+```
+
+Flags:
+
+```
+tuiro --ci
+tuiro --no-color
+tuiro --theme pastel
+tuiro --help
+tuiro --version
+```
+
+Behavior:
+
+- `--ci` disables colors
+- `--no-color` also disables colors
+- If both are provided, colors remain disabled
+- `--theme NAME` selects a built‑in theme
+- `--help` lists available themes
+
+Example:
+
+```
+tuiro --ci --theme mono
+```
+
+## API
+
+### `TUI(ci_mode: bool = False, theme: str | Palette = "default")`
+
+Creates a new terminal UI helper.
+
+### `section(title: str)`
+
+Prints a high‑visibility section header.
+
+### `subsection(title: str)`
+
+Prints a smaller subsection header.
+
+### `banner(title: str)`
+
+Prints a centered banner.
+
+### Status messages
+
+```
+info(message: str)
+success(message: str)
+warning(message: str)
+error(message: str)
+```
+
+### `command(cmd: str | list[str])`
+
+Prints a command being executed. Lists are joined with spaces.
+
+### `result(label: str, value: str)`
+
+Prints a key‑value result line.
+
+### `table(rows: list[tuple[str, str]])`
+
+Prints a simple two‑column table aligned on the left column.
+
+### `step(title: str)`
+
+Context manager for build steps:
+
+```python
+with tui.step("Compiling"):
+    run_compiler()
+```
+
+## License
+
+MIT License. See (LICENSE)[LICENSE] for details.

tuiro-0.1.0/pyproject.toml

@@ -0,0 +1,30 @@
+[project]
+name = "tuiro"
+version = "0.1.0"
+description = "Tiny terminal UI utility for clean, colorful build output."
+readme = "README.md"
+authors = [
+    { name = "NellowTCS", email = "nellowtcs@gmail.com" }
+]
+requires-python = ">=3.10"
+dependencies = []
+
+keywords = ["terminal", "tui", "ansi", "cli", "colors", "logging", "build-tools"]
+
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3 :: Only",
+    "License :: OSI Approved :: MIT License",
+    "Operating System :: OS Independent",
+    "Environment :: Console",
+    "Topic :: Terminals",
+    "Topic :: Software Development :: Build Tools",
+    "Topic :: Utilities"
+]
+
+[build-system]
+requires = ["uv_build>=0.10.2,<0.11.0"]
+build-backend = "uv_build"
+
+[project.scripts]
+tuiro = "tuiro.__main__:main"

tuiro-0.1.0/src/tuiro/__init__.py

@@ -0,0 +1,3 @@
+from .tuiro import TUI
+
+__all__ = ["TUI"]

tuiro-0.1.0/src/tuiro/__main__.py

@@ -0,0 +1,42 @@
+import sys
+from . import TUI
+from .version import __version__
+from .palette import Palette, PROFILES
+
+
+def main():
+    args = sys.argv[1:]
+
+    # Help
+    if "--help" in args or "-h" in args:
+        print("Usage: tuiro [--ci] [--no-color] [--theme NAME] [--help] [--version]")
+        print("Available themes:", ", ".join(PROFILES.keys()))
+        return
+
+    # Version
+    if "--version" in args:
+        print(f"tuiro {__version__}")
+        return
+
+    # Flags
+    force_ci = "--ci" in args
+    force_no_color = "--no-color" in args
+
+    # Theme
+    theme = "default"
+    if "--theme" in args:
+        idx = args.index("--theme")
+        if idx + 1 < len(args):
+            theme = args[idx + 1]
+
+    ci_mode = force_ci or force_no_color
+
+    tui = TUI(ci_mode=ci_mode, theme=theme)
+
+    tui.banner("tuiro")
+    tui.section("Demo")
+    tui.success("tuiro is installed and working!")
+    tui.error("There is no error")
+    tui.info("You are ready to build clean CLI scripts.")
+    if ci_mode:
+        tui.warning("CI mode active")

tuiro-0.1.0/src/tuiro/colors.py

@@ -0,0 +1,49 @@
+
+class Colors:
+    """ANSI color codes."""
+    RESET = "\033[0m"
+    BOLD = "\033[1m"
+    DIM = "\033[2m"
+    
+    # Foreground colors
+    BLACK = "\033[30m"
+    RED = "\033[31m"
+    GREEN = "\033[32m"
+    YELLOW = "\033[33m"
+    BLUE = "\033[34m"
+    MAGENTA = "\033[35m"
+    CYAN = "\033[36m"
+    WHITE = "\033[37m"
+    
+    # Bright foreground colors
+    BRIGHT_BLACK = "\033[90m"
+    BRIGHT_RED = "\033[91m"
+    BRIGHT_GREEN = "\033[92m"
+    BRIGHT_YELLOW = "\033[93m"
+    BRIGHT_BLUE = "\033[94m"
+    BRIGHT_MAGENTA = "\033[95m"
+    BRIGHT_CYAN = "\033[96m"
+    BRIGHT_WHITE = "\033[97m"
+    
+    @staticmethod
+    def disable():
+        """Disable all colors."""
+        Colors.RESET = ""
+        Colors.BOLD = ""
+        Colors.DIM = ""
+        Colors.BLACK = ""
+        Colors.RED = ""
+        Colors.GREEN = ""
+        Colors.YELLOW = ""
+        Colors.BLUE = ""
+        Colors.MAGENTA = ""
+        Colors.CYAN = ""
+        Colors.WHITE = ""
+        Colors.BRIGHT_BLACK = ""
+        Colors.BRIGHT_RED = ""
+        Colors.BRIGHT_GREEN = ""
+        Colors.BRIGHT_YELLOW = ""
+        Colors.BRIGHT_BLUE = ""
+        Colors.BRIGHT_MAGENTA = ""
+        Colors.BRIGHT_CYAN = ""
+        Colors.BRIGHT_WHITE = ""

tuiro-0.1.0/src/tuiro/palette.py

@@ -0,0 +1,37 @@
+from .colors import Colors
+
+class Palette:
+    """Base color palette for tuiro."""
+    info = Colors.CYAN
+    success = Colors.GREEN
+    warning = Colors.YELLOW
+    error = Colors.RED
+    accent = Colors.BRIGHT_BLUE
+    dim = Colors.DIM
+    text = Colors.BRIGHT_WHITE
+
+
+class Mono(Palette):
+    """Monochrome palette."""
+    info = Colors.WHITE
+    success = Colors.WHITE
+    warning = Colors.WHITE
+    error = Colors.WHITE
+    accent = Colors.WHITE
+    text = Colors.WHITE
+
+
+class Pastel(Palette):
+    """pristine pastel palette."""
+    info = Colors.BRIGHT_CYAN
+    success = Colors.BRIGHT_GREEN
+    warning = Colors.BRIGHT_YELLOW
+    error = Colors.BRIGHT_MAGENTA
+    accent = Colors.BRIGHT_BLUE
+    text = Colors.BRIGHT_WHITE
+
+PROFILES = {
+    "default": Palette,
+    "mono": Mono,
+    "pastel": Pastel,
+}

tuiro-0.1.0/src/tuiro/tuiro.py

@@ -0,0 +1,129 @@
+"""tuiro: tiny terminal UI utility for clean, colorful build output."""
+
+from __future__ import annotations
+
+import shutil
+import sys
+from contextlib import contextmanager
+from .colors import Colors
+from .palette import PROFILES, Palette
+
+
+class TUI:
+    """Core TUI class for the tuiro terminal UI library.
+
+    Provides structured terminal output for build scripts,
+    developer tooling, and lightweight CLIs.
+    """
+
+    def __init__(self, ci_mode: bool = False, theme: str | Palette = "default") -> None:
+        """Initialize the TUI.
+
+        Args:
+            ci_mode: If True, disable colors.
+            theme: A theme name or a Palette subclass.
+        """
+        self.ci_mode = ci_mode
+
+        if isinstance(theme, str):
+            theme_cls = PROFILES.get(theme, PROFILES["default"])
+            self.palette = theme_cls()
+        else:
+            self.palette = theme()
+
+        if ci_mode or not sys.stdout.isatty():
+            Colors.disable()
+
+    # ------------------------------------------------------------
+    # Sections and headings
+    # ------------------------------------------------------------
+
+    def section(self, title: str) -> None:
+        width = shutil.get_terminal_size().columns
+        width = max(40, min(width, 120))
+        line = "─" * width
+        c = self.palette.accent
+        print(f"\n{c}{Colors.BOLD}{line}{Colors.RESET}")
+        print(f"{c}{Colors.BOLD}  {title}{Colors.RESET}")
+        print(f"{c}{Colors.BOLD}{line}{Colors.RESET}")
+
+    def subsection(self, title: str) -> None:
+        c = self.palette.accent
+        print(f"\n{c}{Colors.BOLD}▶ {title}{Colors.RESET}")
+
+    # ------------------------------------------------------------
+    # Message types
+    # ------------------------------------------------------------
+
+    def success(self, message: str) -> None:
+        print(f"{self.palette.success}[OK]{Colors.RESET} {message}")
+
+    def info(self, message: str) -> None:
+        print(f"{self.palette.info}[*]{Colors.RESET} {message}")
+
+    def warning(self, message: str) -> None:
+        print(f"{self.palette.warning}[!]{Colors.RESET} {message}")
+
+    def error(self, message: str) -> None:
+        print(f"{self.palette.error}[ERROR]{Colors.RESET} {message}")
+
+    # ------------------------------------------------------------
+    # Utility output
+    # ------------------------------------------------------------
+
+    def command(self, cmd: str | list[str]) -> None:
+        cmd_str = " ".join(cmd) if isinstance(cmd, list) else cmd
+        print(f"{self.palette.dim}$ {cmd_str}{Colors.RESET}")
+
+    def result(self, label: str, value: str) -> None:
+        print(f"{self.palette.text}{label}:{Colors.RESET} {value}")
+
+    def table(self, rows: list[tuple[str, str]]) -> None:
+        if not rows:
+            return
+        left_width = max(len(label) for label, _ in rows)
+        for label, value in rows:
+            print(f"{label.ljust(left_width)}  {value}")
+
+    # ------------------------------------------------------------
+    # Banner
+    # ------------------------------------------------------------
+
+    def banner(self, title: str) -> None:
+        width = shutil.get_terminal_size().columns
+        width = max(40, min(width, 120))
+        c = self.palette.accent
+
+        print(f"\n{c}{Colors.BOLD}")
+        print("╔" + "═" * (width - 2) + "╗")
+        padding = (width - 2 - len(title)) // 2
+        print(
+            "║"
+            + " " * padding
+            + title
+            + " " * (width - 2 - padding - len(title))
+            + "║"
+        )
+        print("╚" + "═" * (width - 2) + "╝")
+        print(f"{Colors.RESET}")
+
+    # ------------------------------------------------------------
+    # Step context manager
+    # ------------------------------------------------------------
+
+    @contextmanager
+    def step(self, title: str):
+        self.info(f"{title}...")
+        try:
+            yield
+            self.success(f"{title} completed")
+        except Exception:
+            self.error(f"{title} failed")
+            raise
+
+    # ------------------------------------------------------------
+    # Representation
+    # ------------------------------------------------------------
+
+    def __repr__(self) -> str:
+        return "<tuiro.TUI: aesthetic terminal UI helper>"

tuiro-0.1.0/src/tuiro/version.py

@@ -0,0 +1 @@
+__version__ = "0.1.0"