Skip to main content

Personal-use console utilities library

Project description

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

Requirements

Dependencies

Standard library modules are used where possible; only external dependencies are listed:

  • rich (12.4.4 or higher)
  • readchar (4.0.0 or higher)
  • requests (2.25.0 or higher)

Python version

Python (3.9 or higher)

Operating System

Any of the following:

  • Windows (10 or higher)
  • Linux (any modern Linux distribution compatible with Python 3.9)
  • MacOS (10.9 or higher)

Google Colaboratory support

This library is fully compatible with Google Colaboratory.


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.
  • wait_for_key(): pauses execution until the user presses a key.

Structure Utilities (structure)

Tools for building structures in console applications:

  • header(): prints a styled header, consisting of a title and a separator.
  • menu(): creates interactive selection menus with header and automatic selection validation.
  • confirmation_menu(): creates a confirmation dialog with custom message and options.
  • confirm_exit(): creates a confirmation dialog that exits the program safely (uses confirmation_menu()).
  • table(): creates personalized tables with easy introduction of fully-styled columns and rows.
  • separator(): prints a fully-personalized 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_list_is_empty(): checks if a list is empty and displays an error screen if it is.
  • validate_option(): validates user selection from a dictionary of options.
  • validate_string(): ensures non-empty string input.
  • validate_integer(): validates integers (uses Continental European numeric format) with optional range validation through an advanced syntax (syntax example: "(-infinity; 0] | 5 | [10; infinity)").
  • validate_double(): validates decimal numbers (uses Continental European numeric format) with support for fractions and mathematical constants ("pi", "e", "tau", "phi") and optional range validation through an advanced syntax (syntax example: "(-infinity; 0,1] | 1/3 | [pi; infinity)").
  • validate_datetime(): validates date and time input (uses Day–Month–Year date format with 24-hour time) with selectable year, time and second inclusion.
  • 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.
  • datetime_format(): formats datetime objects (uses Day–Month–Year date format with 24-hour time) with automatic or custom year, time and second inclusion.
  • id_format(): formats Argentinian national ID numbers.
  • cellphone_number_format(): formats cellphone numbers (uses Argentinian format).

System Utilities (system)

Helpers for interacting with the operating system console environment:

  • set_window_title(): sets the console window title.
  • maximize_window(): maximizes the console window.
  • set_locale(): configures the process locale for number, date, and cultural formatting.
  • get_resources_path(): returns the absolute path to the resources directory, regardless of whether the program is running as a script in an IDE or as an executable.
  • in_google_colaboratory(): returns True if the program is running in Google Colaboratory, False otherwise.

Installation

pip install tui_utilities


Update

pip install -U tui_utilities

Project details


Release history Release notifications | RSS feed

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

tui_utilities-1.9.12.tar.gz (20.0 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

tui_utilities-1.9.12-py3-none-any.whl (19.2 kB view details)

Uploaded Python 3

File details

Details for the file tui_utilities-1.9.12.tar.gz.

File metadata

  • Download URL: tui_utilities-1.9.12.tar.gz
  • Upload date:
  • Size: 20.0 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for tui_utilities-1.9.12.tar.gz
Algorithm Hash digest
SHA256 66ab7a79fe7767911111693b03d0dcb07bf53471ed071ea0228005bb68a1ddcf
MD5 38364c943e76f75af9b20b6721277b49
BLAKE2b-256 fe1d10bf3b58f899bbc8e671e9ebd67bd3a5d8ca36841a8621d5b634659ca059

See more details on using hashes here.

File details

Details for the file tui_utilities-1.9.12-py3-none-any.whl.

File metadata

  • Download URL: tui_utilities-1.9.12-py3-none-any.whl
  • Upload date:
  • Size: 19.2 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.2.0 CPython/3.14.3

File hashes

Hashes for tui_utilities-1.9.12-py3-none-any.whl
Algorithm Hash digest
SHA256 5d9ad2044421fd81d5ba9afb4d6d34bb0d4b0b988d59097c77b59bb22182790d
MD5 cb15621c3402e374878324e1e5fcb08f
BLAKE2b-256 2380a626e83808ab7251e35173e3ddbb8c697ddd138a50a2b9632bfb1d208fac

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page