Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/sinkaroid/booru
Python bindings for booru imageboards
https://github.com/sinkaroid/booru
booru danbooru gelbooru rule34
Last synced: about 1 month ago
JSON representation
Python bindings for booru imageboards
- Host: GitHub
- URL: https://github.com/sinkaroid/booru
- Owner: sinkaroid
- License: mit
- Created: 2022-04-07T09:50:37.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2022-12-08T11:08:03.000Z (about 2 years ago)
- Last Synced: 2024-09-29T14:36:57.558Z (2 months ago)
- Topics: booru, danbooru, gelbooru, rule34
- Language: Python
- Homepage: https://sinkaroid.github.io/booru
- Size: 209 KB
- Stars: 24
- Watchers: 2
- Forks: 3
- Open Issues: 4
-
Metadata Files:
- Readme: README.md
- Contributing: CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-indo-projects - Booru - Python bindings for Booru imageboards. (Python)
- awesome-indonesia-repo - Booru - Python bindings for Booru imageboards. (Python)
README
# Booru
Python bindings for Booru imageboards
- [Booru](#booru)
- [Features](#features)
- [Features availability](#this-library-vs-the-competition)
- [Usage](#usage)
- [Prerequisites](#prerequisites)
- [Installation](#installation)
- [Example](#example)
- [search](#search)
- [search_image](#search_image)
- [find_tags](#find_tags)
- [booru.resolve()](#booruresolve)
- [Import specific booru client](#search)
- [Testing cases](https://github.com/sinkaroid/booru/actions)
- [The core](https://github.com/sinkaroid/booru/actions)
- [Tags completion](https://github.com/sinkaroid/booru/actions/workflows/find_tags.yml)
- [Documentation](#documentation)
- [Legal](#legal)
----
Python bindings for the imageboards.
It is takes a much more functionalities to interacts with ease, and featureful. Making your interaction significantly tidier, less of pain, and hopefully will be reusable.
## Features
- Plenty of imageboards
- Search random & gacha returns
- Tags block, resolved safety tags concerns
- Tags finder, tags & query completion
- Parses and returns the image only
- Documented and tested
- Easy to use, check your intelisense
## Usage
Async context, and it's recommended use [asyncio](https://docs.python.org/3/library/asyncio.html) / https://sinkaroid.github.io/booru
### Prerequisites
NOTE: Python 3.7 or above
### Installation
`pip install booru`
## This library vs. the Competition
**Features availability** for this library
| Booru | Status | Random | Tags block | Tags finder | Get images | Gacha |
| ------------------------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------- | ---------- | ---------- | ----- | ----- | ----- |
| [Gelbooru](https://gelbooru.com/) | [](https://github.com/sinkaroid/booru/actions/workflows/gel.yml) | `Yes` | `Yes` | `Yes` | `Yes` | `Yes` |
| [Danbooru](https://danbooru.donmai.us/) | [](https://github.com/sinkaroid/booru/actions/workflows/danbo.yml) | `Yes` | `Yes` | `Yes` | `Yes` | `Yes` |
| [Rule34](https://rule34.xxx) | [](https://github.com/sinkaroid/booru/actions/workflows/r34.yml) | `Yes` | `Yes` | `Yes` | `Yes` | `Yes` |
| [Realbooru](https://realbooru.com/) | [](https://github.com/sinkaroid/booru/actions/workflows/real.yml) | `Yes` | `Yes` | `Yes` | `Yes` | `Yes` |
| [Tbib](https://tbib.org/) | [](https://github.com/sinkaroid/booru/actions/workflows/tbib.yml) | `Yes` | `Yes` | `Yes` | `Yes` | `Yes` |
| [Xbooru](https://xbooru.com/) | [](https://github.com/sinkaroid/booru/actions/workflows/xbo.yml) | `Yes` | `Yes` | `Yes` | `Yes` | `Yes` |
| [Safebooru](https://safebooru.org/) | [](https://github.com/sinkaroid/booru/actions/workflows/safe.yml) | `Yes` | `Yes` | `Yes` | `Yes` | `Yes` |
| [Yandere](https://yande.re/) | [](https://github.com/sinkaroid/booru/actions/workflows/yande.yml) | `Yes` | `Yes` | `Yes` | `Yes` | `Yes` |
| [Lolibooru](https://lolibooru.moe/) | [](https://github.com/sinkaroid/booru/actions/workflows/loli.yml) | `Yes` | `Yes` | `Yes` | `Yes` | `Yes` |
| [Konachan](https://konachan.com/) | [](https://github.com/sinkaroid/booru/actions/workflows/kona.yml) | `Yes` | `Yes` | `Yes` | `Yes` | `Yes` |
| [Konachan.net](https://konachan.net/) | [](https://github.com/sinkaroid/booru/actions/workflows/konanet.yml) | `Yes` | `Yes` | `Yes` | `Yes` | `Yes` |
| [Hypnohub](https://hypnohub.net/) | [](https://github.com/sinkaroid/booru/actions/workflows/hypno.yml) | `Yes` | `Yes` | `Yes` | `Yes` | `Yes` |
| [E621](https://e621.net/) | [](https://github.com/sinkaroid/booru/actions/workflows/e6.yml) | `Yes` | `No` | `No` | `Yes` | `Yes` |
| [E926](https://e926.net/) | [](https://github.com/sinkaroid/booru/actions/workflows/e9.yml) | `Yes` | `No` | `No` | `Yes` | `Yes` |
| [Derpibooru](https://derpibooru.org/) | [](https://github.com/sinkaroid/booru/actions/workflows/derpi.yml) | `Yes` | `No` | `No` | `Yes` | `Yes` |
| [Furbooru](https://furbooru.org/) | [](https://github.com/sinkaroid/booru/actions/workflows/fur.yml) | `Yes` | `No` | `No` | `Yes` | `Yes` |
| [ATFbooru](https://booru.allthefallen.moe/) | [](https://github.com/sinkaroid/booru/actions/workflows/atf.yml) | `Yes` | `Yes` | `Yes` | `Yes` | `Yes` |
| [Behoimi](http://behoimi.org/) | [](https://github.com/sinkaroid/booru/actions/workflows/behoi.yml) | `Yes` | `No` | `No` | `Yes` | `Yes` |
| [Paheal](https://rule34.paheal.net/) | [](https://github.com/sinkaroid/booru/actions/workflows/paheal.yml) | `Yes` | `No` | `No` | `Yes` | `Yes` |
## Example
### **search()**
Takes parameter `(query: str, block: str = "", limit: int = 100, page: int = 1, random: bool = True, gacha: bool = False)`
```py
import asyncio
import booru
async def main():
dan = booru.Danbooru()
res = await dan.search(query="cat_girl", block="futanari")
print(res) ## this is
print(booru.resolve(res)) ## this is
asyncio.run(main())
```
- You will never gets content which contains futa tags.
You can also import specific booru client.
```py
from booru import Rule34
some_booru = Rule34()
## do with r34
```
### **search_image()**
Takes parameter `(query: str, block: str = "", limit: int = 100, page: int = 1)`
```py
import asyncio
from booru import Rule34
async def main():
r34 = Rule34()
img = await r34.search_image(query="cat_girl", block="futanari")
print(img)
asyncio.run(main())
```
- This will parses image url only, instead object
### **find_tags()**
You want to wildcard or query completion like the browser do?
What browser looks like
This library also
```py
import asyncio
from booru import Danbooru, resolve
async def main():
dan = Danbooru()
find_tags = await dan.find_tags("jeanne") ## arbitrary tags
wildcard = resolve(find_tags)
print(wildcard)
asyncio.run(main())
```
- Get the `wildcard[0]` for the best match.
## booru.resolve()
You will need this for every object, this library designed to be neat and clean returns, although it must be reparsed to the string first, that's why `booru.resolve()` exist.
## Documentation
The documentation can be found https://sinkaroid.github.io/booru
## Legal
This tool can be freely copied, modified, altered, distributed without any attribution whatsoever. However, if you feel
like this tool deserves an attribution, mention it. It won't hurt anybody
> Licence: WTF.