fast-rich 0.3.1

A Rust port of Python's Rich library for beautiful terminal formatting
Documentation 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163

<div align="center">
  <img src="docs/assets/logo.png" width="800" alt="Fast-Rich Logo" />

  <h1>Fast-Rich</h1>

  [![Documentation](https://img.shields.io/badge/docs-GitHub%20Pages-blue.svg)](https://mohammad-albarham.github.io/fast-rich)
  [![Crates.io](https://img.shields.io/crates/v/fast-rich.svg)](https://crates.io/crates/fast-rich)
  [![Rust API](https://docs.rs/fast-rich/badge.svg)](https://docs.rs/fast-rich)
  [![License](https://img.shields.io/crates/l/fast-rich.svg)](https://github.com/mohammad-albarham/fast-rich/blob/main/LICENSE)
  [![Build Status](https://github.com/mohammad-albarham/fast-rich/workflows/CI/badge.svg)](https://github.com/mohammad-albarham/fast-rich/actions)
  ![Status](https://img.shields.io/badge/status-under--development-orange)

  **High-performance Rust port of Python's popular [Rich](https://github.com/Textualize/rich) library.**
  
  *Beautiful terminal formatting for Rust applications.*

  ![Fast-Rich Hero](docs/assets/hero.gif)
</div>

---

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

Fast-Rich empowers your terminal applications with rich text, tables, syntax highlighting, markdown rendering, and more, all with an idiomatic and safe Rust API.

## Feature Showcase

Experience the library's breadth with our automated demonstration:

![Fast-Rich Showcase](docs/assets/run_all.gif)

---

## 🎨 Professional Assets

### 📊 Beautiful Tables
Unicode borders, automatic column alignment, and smart wrapping.

![Tables](docs/assets/tables.png)

### 💻 Syntax Highlighting
Full support for various themes and languages via `syntect`.

![Syntax](docs/assets/syntax.png)

### ⏳ Progress Bars
Multi-threaded tracking with spinners, ETAs, and customizable columns.

![Progress](docs/assets/progress.gif)

### 📈 Live Dashboards
Flicker-free, auto-updating content for real-time monitoring.

![Live](docs/assets/live.gif)

### 🌳 Structural Views
Render hierarchical data and layouts with ease.

<div align="center">
  <img src="docs/assets/tree.png" width="45%" />
  <img src="docs/assets/layout.png" width="45%" />
</div>

## Key Features

- **Rich Text**: Use styled text with bold, italic, underline, and RGB/TrueColor support.
- **Markdown Rendering**: Render headers, lists, and code blocks directly in your terminal.
- **Beautiful Logging**: Structured, colored, and timestamped logging compatible with the `log` crate.
  ![Logging](docs/assets/logging.png)
- **Extensible API**: Create your own renderables and custom style themes.

## Installation

Add `fast-rich` to your `Cargo.toml`:

```toml
[dependencies]
fast-rich = "0.3.1"
```

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

```toml
[dependencies]
fast-rich = { version = "0.3.1", features = ["full"] }
```

Or pick specific features:

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

## Quick Start

```rust
use fast_rich::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

Detailed guides and API references are available at our official documentation site:

👉 **[mohammad-albarham.github.io/fast-rich](https://mohammad-albarham.github.io/fast-rich)**

### Essential Resources
- **[Getting Started](https://mohammad-albarham.github.io/fast-rich/getting-started)**: Installation, first steps, and core concepts.
- **[User Guides](https://mohammad-albarham.github.io/fast-rich/guides)**: Deep dives into Tables, Progress Bars, Live Display, and more.
- **[API Reference](https://docs.rs/fast-rich)**: Comprehensive technical documentation on `docs.rs`.
- **[Examples](https://github.com/mohammad-albarham/fast-rich/tree/main/examples)**: Real-world code samples for every feature.

## Examples

Run the included examples to see features in action:

```bash
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

| Feature | Python Rich | Fast-Rich |
|:--------|:------------|:----------|
| Rich Text | ✅ | ✅ |
| Tables | ✅ | ✅ |
| Progress | ✅ | ✅ |
| Live Display | ✅ | ✅ |
| Syntax Highlighting | ✅ | ✅ |
| Markdown | ✅ | ✅ |
| Layouts | ✅ | ✅ |
| Tracebacks | ✅ | ✅ |
| Inspect | ✅ | ✅ |

## Contributing

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

## License

MIT or Apache-2.0