speak-easy 0.1.2

Logging functionalities with different levels and rotation options built on top of tokio-rs tracing.
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

![Speak Easy — Logging functionalities][splash]

[splash]: https://raw.githubusercontent.com/stefanodecillis/speak-easy/main/assets/crab-contained.jpg

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
[![Crates.io Version](https://img.shields.io/crates/v/speak-easy)](https://crates.io/crates/speak-easy)

# Speak-Easy

Speak-Easy is a Rust library that provides logging functionalities with different levels and rotation options built on top of tokio-rs tracing.

## Features

- Different log levels
- Log rotation options
- Cleanup functionality

## Usage

First, add the following to your `Cargo.toml`:

```toml
[dependencies]
speak-easy = "0.1.1"
tokio = { features = ["macros", "rt-multi-thread"], version = "1.37.0" }
```

Then, use the library in your code like this:


```rust
use speak_easy::speak_easy::SpeakEasy;
use speak_easy::{info, Level};
use speak_easy::{Rotation, SpeakConfig};

#[tokio::main]
async fn main() {
    let speak_config = SpeakConfig::new(
        Rotation::Minutely,
        "./logs".to_string(),
        "my_log".to_string(),
    )
    .with_cleanup(24 * 60 * 60, 5);

    SpeakEasy::init(Level::INFO, Some(speak_config));

    info!("this is a log");
}


```

Please replace "/path/to/log/files" with the actual path where you want to store your log files.

## License
This project is licensed under the MIT License - see the LICENSE file for details.

## Contributing
Feel free to open issues and send PRs. We will evaluate them together in the comment section.