tinify-rs 1.0.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

# Tinify API client for Rust

[![Build Status](https://github.com/Danieroner/tinify-rs/actions/workflows/ci.yml/badge.svg)](https://github.com/Danieroner/tinify-rs/actions)
[![crates.io](https://img.shields.io/crates/v/tinify-rs.svg)](https://crates.io/crates/tinify-rs)

Rust client for the Tinify API, 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).

## Getting Started

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

```toml
[dependencies]
tinify-rs = "1.0.0"
```
## Usage

- About key

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

- Compress from a file
```rust
use tinify::{Tinify, TinifyException};

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

- Compress from an url file
```rust
use tinify::{Tinify, TinifyException};

fn main() -> Result<(), TinifyException> {
  let key = "tinify api key";
  let optimized = Tinify::new()
    .set_key(key)
    .get_client()?
    .from_url("https://tinypng.com/images/panda-happy.png")?
    .to_file("./optimized.png");
 
  Ok(())
}
```

- Compress from a file buffer
```rust
use tinify::{Tinify, TinifyException};
use std::fs;

fn main() -> Result<(), TinifyException> {
  let key = "tinify api key";
  let bytes = fs::read("./unoptimized.png").unwrap();
  let buffer = Tinify::new()
    .set_key(key)
    .get_client()?
    .from_buffer(&bytes)?
    .to_buffer();
  
  let save = fs::write("./optimized.png", buffer).unwrap();
   
  Ok(())
}
```

## Running tests

Create a .env file with a TiniPNG KEY

```
cargo test
```

## Contribution

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