pretty-table 0.1.1

An easy-to-use crate for printing pretty tables or writing them to a file!
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

<div align="center">
  <img src="./assets/logo.png" alt="Your Image Description" style="width: 100%; max-width: 800px;">
</div>

**Pretty Table** is a Rust crate designed to make your life easier when it comes to formatting and displaying 2-D vectors in a visually appealing tabular format. Whether you're working with strings, numbers, or custom types that implement the `Into<String>` trait, Pretty Table has got you covered.

## Features

- **Versatile Input:** Works with any type that implements the `Into<String>` trait.

- **Beautiful Output:** Transform your 2-D vectors into visually pleasing tables.

- **Console and File Output:** Display your tables in the console or write them to a file effortlessly.

## Installation

Add Pretty Table to your `Cargo.toml` file:

```toml
[dependencies]
pretty-table = "0.1.0"
```

Or, run the command at the root of your project

```shell
cargo add pretty-table
```

## Usage

Consider this quick example to get started.

```rust
use pretty_table::prelude::*;

fn main() {
    // define your table as 2-D vectors where all vectors must have `EQUAL` lengths
    let table_data = vec![
        vec!["Name", "Age", "Salary"], // header
        vec!["Altmann", "45", "11.0k"],
        vec!["Bezos", "32", "99.34k"],
        vec!["Pichai", "56", "9.9m"],
        vec!["Cook", "43", "8.2m"],
    ];

    // print to terminal/standard output
    print_table!(table_data.clone());

    // write to file
    write_table_to_file("table.txt", table_data);
}
```

Output:

```shell
+=========+=====+========+
|  Name   | Age | Salary |
+=========+=====+========+
| Altmann | 45  | 11.0k  |
+---------+-----+--------+
|  Bezos  | 32  | 99.34k |
+---------+-----+--------+
| Pichai  | 56  |  9.9m  |
+---------+-----+--------+
|  Cook   | 43  |  8.2m  |
+---------+-----+--------+

```

Explore more examples at `/examples` directory in this repository.

## Documentation
For more in-depth information, check out the documentation.

## Contribution
We welcome contributions! If you have any ideas, bug fixes, or improvements, feel free to open an issue or submit a pull request.

## License
This project is licensed under the MIT License.