tui-utilities 1.0.10__tar.gz

tui_utilities-1.0.10/PKG-INFO

@@ -0,0 +1,129 @@
+Metadata-Version: 2.4
+Name: tui_utilities
+Version: 1.0.10
+Summary: Personal-use console utilities library
+Author-email: Guido Iván Gross <grossguidoivan@gmail.com>
+License: MIT
+Classifier: Programming Language :: Python :: 3
+Classifier: Operating System :: OS Independent
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Software Development :: Libraries
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: rich
+Requires-Dist: readchar
+Requires-Dist: requests
+
+# TUI Utilities
+
+Personal-use console utilities library providing styled terminal interaction, structured menus, robust input validation, formatting helpers, and Spanish-oriented user experience.
+
+/----------------------------------------------------------------------------------------------------/
+
+## Purpose
+
+This library is designed for console-based applications that need:
+
+- Clean TUI
+
+- Structured Spanish-language user interaction
+
+- Robust validation
+
+- Consistent formatting
+
+/----------------------------------------------------------------------------------------------------/
+
+## Dependencies
+
+Standard library modules are used where possible; only external dependencies are listed:
+
+- rich
+
+- readchar
+
+- requests
+
+/----------------------------------------------------------------------------------------------------/
+
+## Features
+
+/----------------------------------------------------------------------------------------------------/
+
+### Console Utilities (console)
+
+Styled terminal interaction built on rich:
+
+- print(): styled print function built on rich, supporting text styles, alignment, padding, and per-segment styling.
+
+- input(): styled input function built on rich, supporting text styles and automatically trimming whitespaces.
+
+- clear_console(): clears the terminal screen (Windows/Linux compatible).
+
+- wait_for_key(): pauses execution until the user presses a key.
+
+/----------------------------------------------------------------------------------------------------/
+
+### Structure Utilities (structure)
+
+Tools for building structures in console applications:
+
+- menu(): creates interactive selection menus with automatic numbering and special options like "Go back" and "Exit".
+
+- confirm_exit(): confirmation dialog that exits the program safely.
+
+- separator(): prints a styled visual separator line.
+
+- error_message(): displays formatted error information including:
+
+    - Custom message
+
+    - Exception details
+
+    - Full traceback
+
+/----------------------------------------------------------------------------------------------------/
+
+### Input Validation (validation)
+
+Interactive validation utilities for user input.
+
+- check_if_empty(): checks if a list is empty and displays an error screen.
+
+- validate_string(): ensures non-empty string input.
+
+- validate_integer(): validates integers (uses Continental European numeric format).
+
+- validate_double(): validates decimal numbers (uses Continental European numeric format).
+
+- validate_date(): validates date and time input (uses Day–Month–Year date format with 24-hour time).
+
+- validate_id(): validates Argentinian national ID numbers.
+
+- validate_cellphone_number(): validates cellphone numbers (uses Argentinian format).
+
+- validate_email(): validates e-mail addresses using an official TLDs list (from IANA's website) or syntax fallback (in case of not having an internet connection or a locally imported list of TLDs).
+
+/----------------------------------------------------------------------------------------------------/
+
+### Formatting Helpers (format)
+
+Utilities for applying consistent formatting:
+
+- decimal_format(): applies Continental European numeric formatting.
+
+- id_format(): formats Argentinian national ID numbers.
+
+- cellphone_number_format(): formats cellphone numbers (uses Argentinian format).
+
+/----------------------------------------------------------------------------------------------------/
+
+## Installation
+
+pip install tui_utilities
+
+/----------------------------------------------------------------------------------------------------/
+
+## Update
+
+pip install -U tui_utilities

tui_utilities-1.0.10/README.md

@@ -0,0 +1,113 @@
+# TUI Utilities
+
+Personal-use console utilities library providing styled terminal interaction, structured menus, robust input validation, formatting helpers, and Spanish-oriented user experience.
+
+/----------------------------------------------------------------------------------------------------/
+
+## Purpose
+
+This library is designed for console-based applications that need:
+
+- Clean TUI
+
+- Structured Spanish-language user interaction
+
+- Robust validation
+
+- Consistent formatting
+
+/----------------------------------------------------------------------------------------------------/
+
+## Dependencies
+
+Standard library modules are used where possible; only external dependencies are listed:
+
+- rich
+
+- readchar
+
+- requests
+
+/----------------------------------------------------------------------------------------------------/
+
+## Features
+
+/----------------------------------------------------------------------------------------------------/
+
+### Console Utilities (console)
+
+Styled terminal interaction built on rich:
+
+- print(): styled print function built on rich, supporting text styles, alignment, padding, and per-segment styling.
+
+- input(): styled input function built on rich, supporting text styles and automatically trimming whitespaces.
+
+- clear_console(): clears the terminal screen (Windows/Linux compatible).
+
+- wait_for_key(): pauses execution until the user presses a key.
+
+/----------------------------------------------------------------------------------------------------/
+
+### Structure Utilities (structure)
+
+Tools for building structures in console applications:
+
+- menu(): creates interactive selection menus with automatic numbering and special options like "Go back" and "Exit".
+
+- confirm_exit(): confirmation dialog that exits the program safely.
+
+- separator(): prints a styled visual separator line.
+
+- error_message(): displays formatted error information including:
+
+    - Custom message
+
+    - Exception details
+
+    - Full traceback
+
+/----------------------------------------------------------------------------------------------------/
+
+### Input Validation (validation)
+
+Interactive validation utilities for user input.
+
+- check_if_empty(): checks if a list is empty and displays an error screen.
+
+- validate_string(): ensures non-empty string input.
+
+- validate_integer(): validates integers (uses Continental European numeric format).
+
+- validate_double(): validates decimal numbers (uses Continental European numeric format).
+
+- validate_date(): validates date and time input (uses Day–Month–Year date format with 24-hour time).
+
+- validate_id(): validates Argentinian national ID numbers.
+
+- validate_cellphone_number(): validates cellphone numbers (uses Argentinian format).
+
+- validate_email(): validates e-mail addresses using an official TLDs list (from IANA's website) or syntax fallback (in case of not having an internet connection or a locally imported list of TLDs).
+
+/----------------------------------------------------------------------------------------------------/
+
+### Formatting Helpers (format)
+
+Utilities for applying consistent formatting:
+
+- decimal_format(): applies Continental European numeric formatting.
+
+- id_format(): formats Argentinian national ID numbers.
+
+- cellphone_number_format(): formats cellphone numbers (uses Argentinian format).
+
+/----------------------------------------------------------------------------------------------------/
+
+## Installation
+
+pip install tui_utilities
+
+/----------------------------------------------------------------------------------------------------/
+
+## Update
+
+pip install -U tui_utilities

tui_utilities-1.0.10/pyproject.toml

@@ -0,0 +1,27 @@
+[project]
+name = "tui_utilities"
+version = "1.0.10"
+description = "Personal-use console utilities library"
+readme = "README.md"
+license = {text = "MIT"}
+authors = [{name = "Guido Iván Gross", email = "grossguidoivan@gmail.com"}]
+requires-python = ">=3.8"
+dependencies = ["rich", "readchar", "requests"]
+
+classifiers = [
+    "Programming Language :: Python :: 3",
+    "Operating System :: OS Independent",
+    "Intended Audience :: Developers",
+    "Topic :: Software Development :: Libraries",
+]
+
+[build-system]
+requires = ["setuptools", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[tool.setuptools]
+packages = ["tui_utilities"]
+include-package-data = true
+
+[tool.setuptools.package-data]
+tui_utilities = ["_tlds/tlds.txt"]

tui_utilities-1.0.10/setup.cfg

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

tui_utilities-1.0.10/tui_utilities/__init__.py

@@ -0,0 +1,21 @@
+from .console import print, input, clear_console, wait_for_key
+from .structure import menu, confirm_exit, separator, error_message
+from .validation import (
+    check_if_empty,
+    validate_string,
+    validate_integer,
+    validate_double,
+    validate_date,
+    validate_id,
+    validate_cellphone_number,
+    validate_email,
+)
+from .format import decimal_format, id_format, cellphone_number_format
+
+__all__ = [
+    "print", "input", "clear_console", "wait_for_key",
+    "menu", "confirm_exit", "separator", "error_message",
+    "check_if_empty", "validate_string", "validate_integer", "validate_double",
+    "validate_date", "validate_id", "validate_cellphone_number", "validate_email",
+    "decimal_format", "id_format", "cellphone_number_format",
+]