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

  <h1>Fast-Rich</h1>

  [![Crates.io](https://img.shields.io/crates/v/fast-rich.svg)](https://crates.io/crates/fast-rich)
  [![Documentation](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.0"
```

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

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

Or pick specific features:

```toml
[dependencies]
fast-rich = { version = "0.2.0", 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

- [Rust API Docs](docs/api.md)
- [Getting Started](docs/rust_getting_started.md)
- [Rust Examples](docs/rust_examples.md)

## 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
