Skip to content

Latest commit

 

History

History
86 lines (63 loc) · 4.46 KB

README.md

File metadata and controls

86 lines (63 loc) · 4.46 KB

Imouto.BooruParser

NuGet license

The dotnet library for retrieving info from booru sites (chan.sankakucomplex.com, danbooru.donmai.us, yande.re, gelbooru.com). You can get individual posts, tags/notes history, and search by tags. Install as NuGet package:

Install-Package Imouto.BooruParser
<PackageReference Include="Imouto.BooruParser" Version="3.*" />

Version 3.3.0

  • Sankaku is child of devil and was broken once again. Removed old auth chan. part as now all logins goes throw beta.

Version 3.2.0

  • Added Rule34, they have a lot of tagged pay-walled staff and I will be using them as tag source for this stuff. No auth is required for now.
  • Sankaku was broken once again. This time they changed their auth flow on their old site. PassHash no longer works. Without auth you also can't get all of post tags (only 20 general tags). I fixed it (only god know for how long). You have to provide login and password and it should work.

Version 3.1

Once again sankaku broke everything. It's now recommended to provide login and pass_hash for sankaku in order to receive all tags from posts. Without it you can only get 20 general tags.

Version 3.0

Have to increment major version due to breaking change in danbooru api usage. Now you have to provide your own user agent for your bot in danbooru settings, otherwise danbooru requests would fail with 403 (recent change on their side).

Version 2.0 released!

The new version of this library has been released. It's a complete rewrite and has a lot of breaking changes. Please don't update unless you're ready to spent some time in refactoring and reading.

The new version has gelbooru as partly supported booru. It doesn't provide a way to get tags or notes history, but you can search and retrieve posts by id or md5. To consume this library you should use IBooruApiLoader interface. The library provides following implementations, one for each booru:

var loader = new DanbooruApiLoader(...);
var loader = new YandereApiLoader(...);
var loader = new SankakuApiLoader(...);
var loader = new GelbooruApiLoader(...);

The recommended way to consume them is to register them in your container:

services.AddBooruParsers();

// OPTIONAL
// It'ts nessesary for Sankaku auth management. 
// You can skip it, if you don't plan to access sankaku with authorization.
services.AddMemoryCache();

But you can also register them yourself. You also need to provide configuration for booru if you want to have more relaxed limits:

services.Configure<DanbooruSettings>(Configuration.GetSection("Danbooru"));
services.Configure<GelbooruSettings>(Configuration.GetSection("Gelbooru"));
services.Configure<SankakuSettings>(Configuration.GetSection("Sankaku"));
services.Configure<YandereSettings>(Configuration.GetSection("Yandere"));

Each settings has PauseBetweenRequestsInMs param which defines a pause between requests. 0 means you can run your requests in parallel and any positive number means that all requests would be called with the provided pause in ms between them. It's important to have some reserves to not get banned.

! Sankaku is a difficult case for the authorization. It requires access and refresh tokens (you can extract them from cookies), but refresh token has to be updated. So SankakuSettings has a callback method SaveTokensCallbackAsync that will be called, when it's necessary to update refresh and access tokens. It's you responsibility to store them somewhere and pass on the next application start.

Simplest usage

var loader = new DanbooruApiLoader(
    new PerBaseUrlFlurlClientFactory(), 
    Options.Create(new DanbooruSettings()))
    
var post = await loader.GetPostAsync(5628013);
Console.WriteLine(post.Md5);

Version 1.x.x

Simplest usage

var username = "user";~~~~
var apiKey = "HBArbAk4WcKTSeAfsyBO";
var delayBetweenRequestsInMs = 1240;

var danbooruLoader = new DanbooruLoader(username, apiKey, delayBetweenRequestsInMs);
var post = await danbooruLoader.LoadPostAsync(5628013);
Console.WriteLine(post.Md5);