philomena 0.5.2

An async Philomena client for Rust
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

# philomena-rs

![Rust](https://github.com/philomena-dev/philomena-rs/workflows/Rust/badge.svg)
![MIT License](https://img.shields.io/github/license/philomena-dev/philomena-rs)
[![Crates.io](https://img.shields.io/crates/v/philomena)](https://crates.io/crates/philomena)

A client for [Philomena](https://github.com/philomena-dev/philomena) (the software that powers boorus such as [Furbooru](https://furbooru.org) and [Derpibooru](https://derpibooru.org))
written in Rust. The APIs for Philomena instances is near identical, so this crate
can work with most of them; however it is optimized for mainline Philomena. Any time new Philomena versions
change the API, this crate will follow these changes.

Usage is simple:

```rust
let user_agent = format!(
  "{}/{} ({}, +{})",
  env!("CARGO_PKG_NAME"),
  env!("CARGO_PKG_VERSION"),
  std::env::var("API_USERNAME").unwrap(),
  env!("CARGO_PKG_REPOSITORY"),
);

let cli = philomena::Client::new(
  "https://furbooru.org/",
  user_agent,
  std::env::var("API_TOKEN").unwrap(),
)?
```

Set the environment variables `API_USERNAME` and `API_TOKEN` to your
username and API token respectively. Adding the username
associated with your bot to each request can help the booru staff when your bot
does unwanted things like violating rate limits.

See the examples for more ideas.