Metadata-Version: 2.3
Name: rule34Py
Version: 4.0.1
Summary: API wrapper for rule34.xxx
License: GPL-3.0-only
Keywords: adult,api-client,nsfw,rule34-pi,rule34.xxx
Author: b3yc0d3
Author-email: b3yc0d3@gmail.com
Maintainer: b3yc0d3
Maintainer-email: b3yc0d3@gmail.com
Requires-Python: >=3.9, <4.0
Classifier: Development Status :: 4 - Beta
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Programming Language :: Python :: 3.13
Requires-Dist: beautifulsoup4
Requires-Dist: lxml
Requires-Dist: requests
Requires-Dist: requests-ratelimiter
Project-URL: Documentation, https://b3yc0d3.github.io/rule34Py/
Project-URL: Issues, https://github.com/b3yc0d3/rule34Py/issues
Project-URL: Repository, https://github.com/b3yc0d3/rule34Py
Description-Content-Type: text/markdown

<div align="center">

# rule34py

![Build Status](https://img.shields.io/github/actions/workflow/status/b3yc0d3/rule34Py/cd-master.yml) ![GPL-3.0](https://img.shields.io/github/license/b3yc0d3/rule34Py) [![](https://img.shields.io/pypi/v/rule34Py)](https://pypi.org/project/rule34Py/) [![](https://img.shields.io/pypi/dm/rule34py?color=blue)](https://pypi.org/project/rule34Py/)

Python API wrapper for [rule34.xxx](https://rule34.xxx/).
</div>


## Installation

[rule34Py](https://pypi.org/project/rule34Py/) is available directly from the Python Package Index and can be installed via `pip`.

```bash
pip install rule34Py
```

Or you can build it from source using this project.
See the [Developer Guide](https://b3yc0d3.github.io/rule34Py/dev/developer-guide.html) for more information.


## Quickstart

```python
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](https://b3yc0d3.github.io/rule34Py/), hosted on the upstream Github Pages. It includes additional **Tutorials**, **User Guides**, **API Documentation**, and more.

See the [Contributing Guide](https://b3yc0d3.github.io/rule34Py/dev/contributing.html) for information about how to contribute to this project and file bugs.

