Skip to main content

A Python library for interacting with the Danbooru API

Project description

PyPI License

Danbooru is a Python library that provides an easy-to-use interface for interacting with the Danbooru API. It allows you to search for posts, retrieve post details, and download media files from the Danbooru image board.

Features

  • Simple and intuitive API for interacting with the Danbooru API

  • Retrieve posts based on tags and limit

  • Download media files (images, videos) associated with the posts

  • Supports asynchronous requests using aiohttp

Installation

You can install Danbooru using pip:

pip install aiodanbooru

Usage

Here’s a simple example that demonstrates how to use the Danbooru library:

from aiodanbooru.api import DanbooruAPI


async def main():
    api = DanbooruAPI(base_url="https://danbooru.donmai.us")

    posts = await api.get_posts(tags=["cat_girl", "solo"], limit=10)
    if posts:
        post = posts[0]
        media_data = await post.get_media()
        with open(post.filename, "wb") as file:
            file.write(media_data)
        print("Media file saved!")


if __name__ == "__main__":
    import asyncio

    loop = asyncio.get_event_loop()
    loop.run_until_complete(main())

For more details and advanced usage examples, please refer to the documentation.

Contributing

Contributions are welcome! If you have any suggestions, bug reports, or feature requests, please open an issue on the GitHub repository. Feel free to submit pull requests with improvements or fixes.

License

This project is licensed under the MIT License. See the LICENSE file for more information.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

aiodanbooru-1.1.1.tar.gz (7.9 kB view hashes)

Uploaded Source

Built Distribution

aiodanbooru-1.1.1-py3-none-any.whl (7.7 kB view hashes)

Uploaded Python 3

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page