/pybooru

Primary LanguagePythonMIT LicenseMIT

Pybooru - Package for Danbooru/Moebooru API

PyPI PyPI GitHub license Documentation Status

Pybooru is a Python package to access to the API of Danbooru/Moebooru based sites.

  • Version: 4.2.2
  • Licensed under: MIT License

Dependencies

  • Python: >= 2.7 or Python: >= 3.3
  • requests

Installation

from Python Package Index (Pypi)

Pybooru on Pypi.

pip install --user Pybooru

Manual installation

git clone git://github.com/luquedaniel/pybooru.git
cd pybooru
pip install --user -r requirements.txt
sudo python setup.py build
python setup.py install

Examples of use

See More examples.

Danbooru

from pybooru import Danbooru

client = Danbooru('danbooru')
artists = client.artist_list('ma')

for artist in artists:
    print("Name: {0}".format(artist['name']))

Login example

from pybooru import Danbooru

client = Danbooru('danbooru', username='your-username', api_key='your-apikey')
client.comment_create(post_id=id, body='Comment content')

Moebooru

from pybooru import Moebooru

client = Moebooru('konachan')
artists = client.artist_list(name='neko')

for artist in artists:
    print("Name: {0}".format(artist['name']))

Login example

Default sites
from pybooru import Moebooru

client = Moebooru('konachan', username='your-username', password='your-password')
client.comment_create(post_id=id, comment_body='Comment content')
Not default sites
from pybooru import Moebooru

client = Moebooru('konachan.com', username='your-username', password='your-password',
                  hash_string='So-I-Heard-You-Like-Mupkids-?--{0}--')
client.comment_create(post_id=id, comment_body='Comment content')

Documentation

You can consult the documentation on Read the Docs

Status

Platform Master Develop
Linux & OSX (Travis CI) Travis CI Travis CI
Windows (AppVeyor) AppVeyor AppVeyor

Contributing

Feel free to contribute, take a look at CONTRIBUTING.

License