Rich

Rich is a comprehensive library for building sophisticated command-line interfaces and terminal applications. It provides a robust console formatting engine and a layout framework that enables developers to render rich text, syntax-highlighted code, and complex data structures directly in the terminal. By utilizing a recursive constraint-based layout engine, the library allows for the creation of hierarchical grids, panels, and trees that maintain their structure even as terminal dimensions change.

What distinguishes the library is its ability to manage persistent, real-time terminal interfaces through live display management and buffered stream handling. It offers granular control over output through a protocol-based rendering system, allowing developers to define custom representations for objects and manage complex visual arrangements. The library also includes a specialized diagnostic suite that automatically captures and transforms raw stack traces into human-readable, syntax-highlighted error reports, complete with local variable inspection.

Beyond its core rendering capabilities, the library provides a suite of tools for data visualization and user interaction. This includes support for nested progress tracking, animated status indicators, and interactive input prompts. Developers can apply consistent visual branding across their applications using a centralized markup-based styling system, which supports reusable themes, color palettes, and text attributes for precise alignment and formatting.

The library automatically detects the host terminal environment to ensure compatibility and visual consistency across different systems.

Features

Command Line Interface Frameworks - Builds professional, interactive terminal applications with advanced text styling and complex interface layouts.

Terminal UI Frameworks - Constructs sophisticated terminal interfaces using a versatile set of layout primitives and interactive visual components.

Console Formatting Engines - Transforms raw text and structured data into color-coded, human-readable output for console environments.

Constraint-Based - Calculates precise dimensions for nested interface elements to ensure content remains perfectly aligned within available terminal space.

Console Style Definitions - Applies reusable text styles using simple string syntax to manage colors, background highlights, and formatting attributes.

Rich Content Renderers - Renders styled text, syntax-highlighted code, and complex data structures directly to the terminal screen.

Live Display Management - Maintains persistent terminal interfaces that automatically refresh to display real-time updates for long-running processes.

Terminal UI Layouts - Organizes console output into hierarchical grids, panels, and trees to manage high-density information displays.

Data Pretty Printers - Pretty-prints nested data structures with configurable indentation and truncation for improved readability.

CLI Interaction Helpers - Facilitates user input collection through styled prompts that preserve standard line editing and history.

Layout Constraints - Enforces fixed dimensions and aspect ratios on interface regions to maintain structural stability during window resizing.

Grid Layouts - Positions information into clean, column-based structures to enhance the clarity of terminal displays.

Terminal Layout Engines - Manages complex multi-segment terminal layouts by yielding renderable components that adapt to the console environment.

Terminal Output Managers - Intercepts standard output streams to preserve the integrity of nested interface components during complex rendering operations.

Real Time Process Monitors - Visualizes background task progress through live status spinners, updating metrics, and dynamic progress bars.

CLI Development - Listed in the “CLI Development” section of the Awesome Python awesome list.

Code Quality Tools - Library for rich terminal text and formatting.

Logging and Output - Provides rich text and beautiful formatting for terminal output.

Concurrent - Coordinates multiple simultaneous progress trackers to monitor concurrent tasks within a single terminal view.

Buffered Streams - Buffers output streams to maintain persistent display regions and prevent visual corruption during rapid content updates.

Hierarchical Progress Trackers - Displays hierarchical task completion by nesting sub-task progress bars within a primary parent tracker.

Terminal Data Visualizers - Presents structured logs and complex objects in a readable, color-coded format optimized for console visualization.

Error Reporters - Captures and displays detailed, color-highlighted stack traces to simplify diagnostic analysis during application debugging.

Protocol-Based Renderers - Interface-based recursion flattens complex UI hierarchies into a stream of renderable segments for the console engine.

Data Visualization Components - Generates structured visual elements like tables, trees, and progress bars directly within terminal environments.

Exception Formatting - Transforms raw error tracebacks into readable, highlighted reports to improve clarity during failure analysis.

Data Tables - Structures raw data into clear, readable tables with customizable headers, column widths, and alignment.

Markup-Based Output Formatters - Parses bracket-based syntax to apply styles, colors, and hyperlinks to text content.

Markup Parsers - Interprets bracketed markup to convert plain text into styled, colorful console output.

Traceback Filters - Prunes irrelevant modules and file paths from error reports to focus on application-specific code.

Command Line Styling Themes - Centralizes color and formatting definitions to ensure consistent visual branding across command-line interfaces.

Loading Indicators - Shows animated indicators to represent background tasks without disrupting terminal output.

Code Line Numbering - Automates the addition of line numbers to source code blocks to enhance reference and readability.

Terminal Environment Detectors - Detects terminal capabilities to optimize ANSI control code usage and output formatting.

Tree View Visualizers - Draws hierarchical data with visual guides and branch styling to keep nested structures distinct.

Text Formatting Configurations - Adjusts text flow, alignment, and wrapping behavior to ensure precise visual layout.

Style Object Managers - Combines formatting attributes programmatically to build reusable style configurations for consistent output.

Code Highlighting - Highlights source code syntax directly within the terminal for improved developer experience.

Markup String Renderers - Displays formatted strings while allowing developers to toggle markup parsing for raw data handling.

Syntax Highlighting Themes - Applies predefined color palettes to code blocks for enhanced visual readability.

Textualizerich

Features

Star history