tinify-rs 1.3.0

A Rust client for the Tinify API
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

# Tinify API client for Rust 🦀

<p align="center">
  <img src="https://tinypng.com/images/panda-happy.png" alt="Tinify"/>
</p>
</p>
<p align="center">
  <a href="https://github.com/Danieroner/tinify-rs/actions">
    <img alt="CI Status" src="https://github.com/Danieroner/tinify-rs/actions/workflows/ci.yml/badge.svg" />
  </a>
  <a href="https://crates.io/crates/tinify-rs">
    <img alt="Crate Version" src="https://img.shields.io/crates/v/tinify-rs.svg" />
  </a>
</p>

Tinify API Client for the Rust Programming Language, used for [TinyPNG](https://tinypng.com) and [TinyJPG](https://tinyjpg.com). Tinify compresses your images intelligently. Read more at [https://tinify.com](https://tinify.com).

## Documentation

[Go to the documentation for the HTTP client](https://tinypng.com/developers/reference).

## Status

In currently development.

There are still features of TinyPNG to implement.

To look at all the features of Tinify API: [Documentation](https://tinypng.com/developers/reference).

## Roadmap

 * [x] Compressing images
 * [x] Resizing images
 * [x] Converting images
 * [ ] Preserving metadata
 * [ ] Saving to Amazon S3
 * [ ] Saving to Google Cloud Storage
 * [x] Implement an async non-blocking Client


## Getting Started

Install the API client with Cargo. Add this to `Cargo.toml`:

```toml
[dependencies]
tinify-rs = "1.3.0"
```

Using async client

```toml
[dependencies]
tinify-rs = { version = "1.3.0", features = ["async"] }
```

## Usage

- About key

  Get an API key from  https://tinypng.com/developers

- Compress from a file
```rust
use tinify::Tinify;
use tinify::TinifyError;

fn main() -> Result<(), TinifyError> {
  let key = "tinify api key";
  let tinify = Tinify::new().set_key(key);
  let client = tinify.get_client()?;
  let _ = client
    .from_file("./unoptimized.jpg")?
    .to_file("./optimized.jpg")?;
    
  Ok(())
}
```

- Compress from a file async
```rust
use tinify::async_bin::Tinify as AsyncTinify;
use tinify::error::TinifyError;

#[tokio::main]
async fn main() -> Result<(), TinifyError> {
  let key = "tinify api key";
  let tinify = AsyncTinify::new().set_key(key);
  let client = tinify.get_async_client()?;
  client
    .from_file("./unoptimized.jpg")
    .await?
    .to_file("./optimized.jpg")?;

  Ok(())
}
```

## Running tests

Create a .env file with a TiniPNG KEY

```
cargo test --features async
```

## Contribution

All contributions will be welcomed. Feel free to open any issues or pull requests.