rule34scraper 1.0.1

A fast Python API wrapper for rule34 image board

rule34scraper

A fast Python API wrapper for booru-style image boards using selectolax (Lexbor engine).

Installation

pip install rule34scraper

Usage

Basic Usage

from rule34scraper import R34Client

with R34Client() as client:
    # Search posts by tags
    posts, tags = client.get_posts(tags="landscape", page=1)
    
    for post in posts:
        print(f"ID: {post.id}, Score: {post.score}, Rating: {post.rating}")
    
    # Get post details
    details = client.get_post_details(posts[0].id)
    print(f"Image: {details.image_url}")
    print(f"Size: {details.width}x{details.height}")
    
    # Download image
    client.download_post(details, directory="downloads/")

Custom Base URL

from rule34scraper import R34Client

# Use a different booru site
client = R34Client(
    base_url="https://example.com/index.php",
    posts_per_page=42,
    timeout=60.0,
)

# Custom headers
client = R34Client(
    base_url="https://example.com/index.php",
    headers={"Cookie": "session=abc123"},
)

Async Client

import asyncio
from rule34scraper import AsyncR34Client

async def main():
    async with AsyncR34Client() as client:
        posts, tags = await client.get_posts(tags="portrait", page=1)
        details = await client.get_post_details(posts[0].id)
        print(f"Image: {details.image_url}")

asyncio.run(main())

User Profiles

with R34Client() as client:
    profile = client.get_user_profile("username")
    print(f"User: {profile.username} (ID: {profile.id})")
    print(f"Level: {profile.level}")
    print(f"Posts: {profile.post_count}")
    print(f"Favorites: {profile.favorite_count}")

Models

• Post - Thumbnail entry from search results
• PostDetails - Full post metadata (image URL, dimensions, tags, comments)
• Tag - Tag with name, count, and type
• PostComment - User comment on a post
• UserProfile - User profile with stats and recent posts

Configuration Options

Parameter	Type	Default	Description
base_url	str	https://rule34.xxx/index.php	Base URL for the API
timeout	float	30.0	Request timeout in seconds
posts_per_page	int	42	Posts per page for pagination
headers	dict	Browser-like headers	Custom HTTP headers

License

MIT