Display TTY  1
Customise your terminal's output
Loading...
Searching...
No Matches
display_tty Namespace Reference

Namespaces

namespace  __main__
 
namespace  src
 

Variables

 Display = Disp
 
 DispTTY = Disp
 
 DisplayTTY = Disp
 
 DisplayLoggerColours = LoggerColours
 
 LC = LoggerColours
 
 DLC = LoggerColours
 
 LOG_BLUE = LoggerColours.BLUE
 
 LOG_RED = LoggerColours.RED
 
 LOG_CYAN = LoggerColours.CYAN
 
 LOG_BLACK = LoggerColours.BLACK
 
 LOG_GREEN = LoggerColours.GREEN
 
 LOG_WHITE = LoggerColours.WHITE
 
 LOG_YELLOW = LoggerColours.YELLOW
 
 LOG_PURPLE = LoggerColours.PURPLE
 
 LOG_LIGHT_RED = LoggerColours.LIGHT_RED
 
 LOG_LIGHT_BLUE = LoggerColours.LIGHT_BLUE
 
 LOG_LIGHT_CYAN = LoggerColours.LIGHT_CYAN
 
 LOG_LIGHT_WHITE = LoggerColours.LIGHT_WHITE
 
 LOG_LIGHT_BLACK = LoggerColours.LIGHT_BLACK
 
 LOG_LIGHT_GREEN = LoggerColours.LIGHT_GREEN
 
 LOG_LIGHT_YELLOW = LoggerColours.LIGHT_YELLOW
 
 LOG_LIGHT_PURPLE = LoggerColours.LIGHT_PURPLE
 

Detailed Description

# +==== BEGIN display_tty =================+
# LOGO: 
# ..@@@@@@@@@@@@@@@@@@@@@@@@@@@@@
# .@...........................#@
# @############################.@
# @...........................@.@
# @..#######################..@.@
# @.#########################.@.@
# @.##>_#####################.@.@
# @.#########################.@.@
# @.#########################.@.@
# @.#########################.@.@
# @.#########################.@.@
# @..#######################..@.@
# @...........................@.@
# @..+----+______________.....@.@
# @..+....+______________+....@.@
# @..+----+...................@.@
# @...........................@.#
# @@@@@@@@@@@@@@@@@@@@@@@@@@@@@#.
# /STOP
# PROJECT: display_tty
# FILE: __init__.py
# CREATION DATE: 06-11-2025
# LAST Modified: 13:48:5 06-11-2025
# DESCRIPTION: 
# A module that allows you to display text with a few boilers (i.e. put your text in a square for titles). It also allows to log to the terminal by wrapping around the logging library.
# @file __init__.py
# @brief This file initializes the `display_tty` library, making its components accessible for external use.
# 
# This module serves as the entry point for the `display_tty` library. It imports and rebinds various classes, constants, 
# and configurations from the `src` submodule, allowing users to easily access and utilize them in their programs.
# 
# The file also defines aliases for certain classes and constants to provide flexibility in naming conventions. 
# Additionally, it exposes a comprehensive list of public symbols via the `__all__` variable, ensuring proper encapsulation 
# and controlled access to the library's components.
# 
# @details
# - Rebinds the `Disp` class to multiple aliases for convenience.
# - Provides a set of predefined color constants for logging purposes.
# - Exposes configuration keys and default settings for output modes and animations.
# - Includes constants for logging statuses and forbidden log levels.
# 
# @note This file is automatically imported when the `display_tty` library is used in another Python program.
# 
# @see src/Disp
# @see src/LoggerColours
# /STOP
# COPYRIGHT: (c) Henry Letellier
# PURPOSE: File in charge of allowing the module to be easily imported into other programs.
# // AR
# +==== END display_tty =================+

Variable Documentation

◆ Display

display_tty.Display = Disp

Definition at line 73 of file __init__.py.

◆ DisplayLoggerColours

display_tty.DisplayLoggerColours = LoggerColours

Definition at line 85 of file __init__.py.

◆ DisplayTTY

display_tty.DisplayTTY = Disp

Definition at line 81 of file __init__.py.

◆ DispTTY

display_tty.DispTTY = Disp

Definition at line 77 of file __init__.py.

◆ DLC

display_tty.DLC = LoggerColours

Definition at line 87 of file __init__.py.

◆ LC

display_tty.LC = LoggerColours

Definition at line 86 of file __init__.py.

◆ LOG_BLACK

display_tty.LOG_BLACK = LoggerColours.BLACK

Definition at line 96 of file __init__.py.

◆ LOG_BLUE

display_tty.LOG_BLUE = LoggerColours.BLUE

Definition at line 91 of file __init__.py.

◆ LOG_CYAN

display_tty.LOG_CYAN = LoggerColours.CYAN

Definition at line 94 of file __init__.py.

◆ LOG_GREEN

display_tty.LOG_GREEN = LoggerColours.GREEN

Definition at line 98 of file __init__.py.

◆ LOG_LIGHT_BLACK

display_tty.LOG_LIGHT_BLACK = LoggerColours.LIGHT_BLACK

Definition at line 114 of file __init__.py.

◆ LOG_LIGHT_BLUE

display_tty.LOG_LIGHT_BLUE = LoggerColours.LIGHT_BLUE

Definition at line 108 of file __init__.py.

◆ LOG_LIGHT_CYAN

display_tty.LOG_LIGHT_CYAN = LoggerColours.LIGHT_CYAN

Definition at line 110 of file __init__.py.

◆ LOG_LIGHT_GREEN

display_tty.LOG_LIGHT_GREEN = LoggerColours.LIGHT_GREEN

Definition at line 116 of file __init__.py.

◆ LOG_LIGHT_PURPLE

display_tty.LOG_LIGHT_PURPLE = LoggerColours.LIGHT_PURPLE

Definition at line 120 of file __init__.py.

◆ LOG_LIGHT_RED

display_tty.LOG_LIGHT_RED = LoggerColours.LIGHT_RED

Definition at line 106 of file __init__.py.

◆ LOG_LIGHT_WHITE

display_tty.LOG_LIGHT_WHITE = LoggerColours.LIGHT_WHITE

Definition at line 112 of file __init__.py.

◆ LOG_LIGHT_YELLOW

display_tty.LOG_LIGHT_YELLOW = LoggerColours.LIGHT_YELLOW

Definition at line 118 of file __init__.py.

◆ LOG_PURPLE

display_tty.LOG_PURPLE = LoggerColours.PURPLE

Definition at line 104 of file __init__.py.

◆ LOG_RED

display_tty.LOG_RED = LoggerColours.RED

Definition at line 92 of file __init__.py.

◆ LOG_WHITE

display_tty.LOG_WHITE = LoggerColours.WHITE

Definition at line 100 of file __init__.py.

◆ LOG_YELLOW

display_tty.LOG_YELLOW = LoggerColours.YELLOW

Definition at line 102 of file __init__.py.