fluffyf 0.1.0

An e621 api wrapper and downloader
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
110
111

# fluffyf

fluffyf is pretty much a rust library and application implementing API requests
to E621/E926 with the primary focus of downloading posts and pools.

Before anything, please read [E926's API documentation](https://e926.net/wiki_pages/2425#api),
it helps, trust me.

If you're new to asynchronous programming in Rust (like me), you should read
[the async book](https://rust-lang.github.io/async-book/), and maybe
even [tokio's tutorial](https://tokio.rs/tokio/tutorial).

## Current State

`fluffyf` is currently
- barely usable
- missing a lot of features
- still lackluster in proper async implementation
- severely underdocumented

`fluffyget` is currently
- lacking pool fetching
- can't handle file based input
- etc

`fluffypost` is currently **unusable and not ready yet**

## Installation

The entire fluffyf project consists of two parts: library and binary.

### Library

Add the following to your `Cargo.toml`:

```toml
[dependencies]
fluffyf = "0.1"
```

### Binary

Run the following on your favorite shell:

```sh
$ cargo install fluffyf
```

and assuming that you have added `$HOME/.cargo/bin` to PATH:

```sh
$ fluffyget --help
```

should output a help message.

## Features

Features can be enabled through `Cargo.toml`, either by:

```toml
[dependencies]
fluffyf = { version = "0.1", features = ["rate-limit"] }
```

or:

```toml
[dependencies]

[dependencies.fluffyf]
default-features = false
features = ["rate-limit"]
version = "0.1"
```

## Versioning

Regarding versioning and breaking changes.

### SemVer

This project uses SemVer 2.0. However, as of January 2024, this project has not reached
version `1.0.0` yet.<br>
As such, **expect extreme amounts of breaking changes per minor version changes**

### MSRV

Due to the nature of async programming in Rust, fluffyf is almost forced
to use a very high (or "cutting-edge") minimum supported Rust version.

Note: after `1.0.0`, MSRV changes will only happen every major version change.

## License
This project is under a dual license of:

- BSD 2-Clause License
- Apache License, Version 2.0

at Your (as defined in the Apache 2.0 License) option.

Unless explicitly stated otherwise, any Contribution made by any Contributor to the Work
shall be implicitly dual licensed as stated above.

### Some Attribution

@nasso, @playfulkittykat for `rate_limit` in [rs621](https://github.com/nasso/rs621)

## This Project is Under Construction 🚧

Create an issue, pull request (if you know how to implement the feature) or contact me directly if you have a suggestion.