Fast-Rich

[!IMPORTANT] This project is currently in Alpha. APIs are subject to change, and some features may be incomplete.

Fast-Rich is a Rust port of Python's popular Rich library. It empowers your terminal applications with rich text, tables, syntax highlighting, markdown rendering, and more, all with an idiomatic and safe Rust API.

Features

• Rich Text: Use styled text with bold, italic, underline, and RGB/TrueColor support.
• Tables: Render beautiful tables with Unicode borders, column alignment, and auto-sizing.
• Progress Bars: Track tasks with multi-bar support, spinners, ETA, and customizable columns.
• Live Display: Create flicker-free, auto-updating displays for dashboards and dynamic content.
• Syntax Highlighting: Highlight code snippets using syntect with multiple themes (Monokai, Solarized, etc.).
• Markdown: Render Markdown content (headers, lists, code blocks, blockquotes) directly in the terminal.
• Hierarchical Data: Display tree structures and nested data.
• Beautiful Logging: structured, colored, and timestamped logging compatible with the log crate.
• Layouts: Split the screen into customizable layouts (vertical, horizontal, nested).
• Panels & Rules: Organize content with bordered panels and horizontal rules.

Installation

Add fast-rich to your Cargo.toml:

[dependencies]
fast-rich = "0.2.0"

To enable all features (including Syntax Highlighting and Markdown, which bring in extra dependencies):

[dependencies]
fast-rich = { version = "0.2.0", features = ["full"] }

Or pick specific features:

[dependencies]
fast-rich = { version = "0.2.0", features = ["syntax", "markdown", "logging"] }

Quick Start

use rich_rust::prelude::*;

fn main() {
    let console = Console::new();

    // Styled text using markup
    console.print("[bold red]Hello[/] [blue]World[/]!");

    // Create a table
    let mut table = Table::new();
    table.add_column("Features");
    table.add_column("Status");
    table.add_row_strs(&["Rich Text", "✅ Ready"]);
    table.add_row_strs(&["Tables", "✅ Ready"]);
    
    // Render the table
    console.print_renderable(&table);
}

Documentation

• Rust API Docs
• Getting Started
• Rust Examples

Examples

Run the included examples to see features in action:

cargo run --example showcase
cargo run --example syntax_highlighting --features syntax
cargo run --example live_clock
cargo run --example progress_rich
cargo run --example logging --features logging

Comparisons

Contributing

Contributions are welcome! Please check out CONTRIBUTING.md for guidelines on how to get started.

License

MIT or Apache-2.0