Python bindings for Derpibooru's API
Project description
DerPyBooru
Python bindings for Derpibooru's API
License: Simplified BSD License
Version: 0.9.1
Features
- High-level abstraction over Derpibooru's REST API
- Parameter chaining for ease of manipulation
- Syntactic sugar for queries, e.g., "query.score >= 100" compiling to "score.gte:100"
- Design focusing on iterables and lazy generation for network efficiency
Dependencies
- python3.0 or newer
- requests
About this Fork
This is a fork of the DerPyBooru package; it is meant to be a drop in replacement for the modules in that package.
How to install
Python 3.x
$ pip3 install derpybooru-nullforce
Checking documentation
Python 3.x
$ pydoc3 derpibooru
Typical usage
Getting images currently on Derpibooru's front page
from derpibooru import Search
for image in Search():
id_number, score, tags = image.id, image.score, ", ".join(image.tags)
print("#{} - score: {:>3} - {}".format(id_number, score, tags))
Searching posts by tag
from derpibooru import Search
for image in Search().query("rarity", "twilight sparkle"):
print(image.url)
Crawling Derpibooru from first to last post
from derpibooru import Search
# This is only an example and shouldn't be used in practice as it abuses
# Derpibooru's licensing terms
for image in Search().ascending().limit(None):
id_number, score, tags = image.id, image.score, ", ".join(image.tags)
print("#{} - score: {:>3} - {}".format(id_number, score, tags))
Getting random posts
from derpibooru import Search, sort
for post in Search().sort_by(sort.RANDOM):
print(post.url)
Getting top 100 posts
from derpibooru import Search, sort
top_scoring = [post for post in Search().sort_by(sort.SCORE).limit(100)]
Storing and passing new search parameters
from derpibooru import Search, sort
params = Search().sort_by(sort.SCORE).limit(100).parameters
top_scoring = Search(**params)
top_animated = top_scoring.query("animated")
Filtering by metadata
from derpibooru import Search, query
q = {
"wallpaper",
query.width == 1920,
query.height == 1080,
query.score >= 100
}
wallpapers = [image for image in Search().query(*q)]
Getting the latest images from a watchlist
from derpibooru import Search, user
key = "your_api_key"
for post in Search().key(key).watched(user.ONLY):
id_number, score, tags = post.id, post.score, ", ".join(post.tags)
print("#{} - score: {:>3} - {}".format(id_number, score, tags))
Changelog
See CHANGELOG
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Close
Hashes for DerPyBooru_Nullforce-0.9.2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | d16117b6678f6083abf7d48b7454cebaf4565d42ee2823be6d7b12b6ece07923 |
|
MD5 | aa2c95ed4c4f7bb6f9ea4ce7850c971e |
|
BLAKE2b-256 | d3552f78009a2529b74eb425812a5010b32f8f8a91736b0eed01f6903738e777 |
Close
Hashes for DerPyBooru_Nullforce-0.9.2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0038b5730efed281b94bc88c97b6195ff6dc3340005de3f278ee9b7230d9c75f |
|
MD5 | 4e10beff25295ad3765f4a7b4d1287da |
|
BLAKE2b-256 | 537740f9dd6316a0e82101c47cab6bd52e2a204c2d385e00c6c0d20d428f19b5 |