<div align="center">

rule34py

Python API wrapper for rule34.xxx.

</div>

Installation

rule34Py is available directly from the Python Package Index and can be installed via pip.

pip install rule34Py

Or you can build it from source using this project. See the Developer Guide for more information.

Quickstart

from rule34Py import rule34Py
client = rule34Py()
client.api_key = "YOUR_API_KEY"
client.user_id = "YOUR_USER_ID"

# Get comments of an post.
client.get_comments(4153825)

# Get post by its id.
client.get_post(4153825)

# Get top 100 icame.
client.icame()

# Search for posts by tag(s).
client.search(["neko"], page_id=2, limit=50)

# Get pool by id.
client.get_pool(28)

# Get a random post.
random = client.random_post()

# Get just a random post ID.
random_id = client.random_post_id()

Documentation

This project has extensive documentation, hosted on the upstream Github Pages. It includes additional Tutorials, User Guides, API Documentation, and more.

See the Contributing Guide for information about how to contribute to this project and file bugs.