Python bindings for Derpibooru's API
Project description
DerPyBooru-Nullforce
Python bindings for Derpibooru's API
License: Simplified BSD License
Version | |
Python Versions | |
Downloads |
About this Fork
This is a fork of the joshua-stone/DerPyBooru repository; it is meant to be a drop in replacement for the modules in that package.
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
- python 2.7, 3.0 or newer
- requests
How to install
pip install derpybooru-nullforce
Checking documentation
pydoc 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
[0.9.3]
Fixed
- Encoding error in setup.py when running Python 2.7
Other
- Added badges to README and other document changes
- Adopt tox for package install testing
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.4a2.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | c95202807b48bce2e93730ce1c631146c4f8bf614a7948af87b8355255941491 |
|
MD5 | ee38bb222a4c403e63d91cd651b4a88c |
|
BLAKE2b-256 | 200269c0e84f0050b4172e81063f782f35fdb990d23ae837a64988edb0a6928c |
Close
Hashes for DerPyBooru_Nullforce-0.9.4a2-py2.py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 001baf2218f6be01658f98a065b6454a4e395689bd4182cdae365d18da9124d0 |
|
MD5 | ef9200e35770bd4e9148ce7dff48c2bf |
|
BLAKE2b-256 | f5902fc219d03de8e118cc4343420ae95528a4d797babc54f28f3b700cd0a587 |