Python bindings for Derpibooru's API
Project description
DerPyBooru
Python bindings for Derpibooru's API
License: Simplified BSD License
Version: 0.8
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
- python2.7 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.
To use, use derpybooru_nullforce
where you see derpybooru
used below.
How to install
Python 2.7
$ pip install derpybooru
Python 3.x
$ pip3 install derpybooru
Checking documentation
Python 2.7
$ pydoc derpibooru
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
0.8.0
- Updated sort to include wilson and width
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.8.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 9246160645719da7b991482c9ed6869aaf9587511bf2b176ba91824513f68948 |
|
MD5 | deff8d8e8984fd219b02280cbfd9d1c4 |
|
BLAKE2b-256 | f7698006f537ee5e9ca0ceb28f6586da69d76f00516b7e85964ea329790da5e7 |
Close
Hashes for DerPyBooru_Nullforce-0.8.0-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3638ae50af146c2dddd32d17c4b2ae79383bf3437ac14a1ca6c4e0d641725a14 |
|
MD5 | dbdb72d9c0c5482df438c1a035107079 |
|
BLAKE2b-256 | 27e21a326cde1acb9fbe1615f2296ea789cf6cfd0845050702220a2c2035460f |