Metadata-Version: 2.1
Name: rule34Py
Version: 1.1.10
Summary: API wraper for rule34.xxx
Home-page: https://github.com/b3yc0d3/rule34Py
Author: b3yc0d3
Author-email: mc25.studio@gmail.com
License: UNKNOWN
Platform: UNKNOWN
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.6
Classifier: Programming Language :: Python :: 3.7
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Description-Content-Type: text/markdown
Requires-Dist: beautifulsoup4 (~=4.9.3)
Requires-Dist: requests (~=2.25.1)

# rule34Py
![](https://img.shields.io/pypi/status/rule34Py) ![](https://img.shields.io/pypi/format/rule34Py) ![](https://img.shields.io/pypi/v/rule34Py) ![](https://img.shields.io/github/license/b3yc0d3/rule34Py) ![](https://img.shields.io/github/languages/code-size/b3yc0d3/rule34Py)\
This is a Simple rule34.xxx API wraper.

## Installation
`pip install rule34Py`
\
\
**Code Snippet:**
```python
from rule34Py import rule34Py

r34Py = rule34Py()

results = r34Py.search(['neko'], 10)
favs = r34Py.getFavorites(118538, true)
comments = r34Py.getComments(4485507)
post = r34Py.getPost(4485507)


print(favs)
```

---

## Usage
- [Class: rule34Py](#rule34Py)
    - [getComments(<post_id>)](#getcomments)
    - [getFavorites(<user_id>, <?id_only>)](#getfavorites)
    - [getPost(<post_id>)](#getpost)
    - [search(\[\<tags>\], <?limit>)](#search)

## rule34Py
Syntax: `r34Py = rule34Py()`

Creates a new rule34Py instance.

## getComments
Syntax: `<rule34Py>.getCommanets(<post_id>)`
- `post_id` \<int>
- returns: \<list>

Get Comments from a Post.

## getFavorites
Syntax: `<rule34Py>.getFavorites(<user_id>, <?id_only>)`
- `user_id` \<int>
- `id_only` \<boolean> (Optional, Defaults is false)
- returns: \<list>

Gets Favorites from a User.

## getPost
Syntax: `<rule34Py>.getPost(<post_id>)`
- `post_id` \<int>
- returns: \<dictionary>

Gets Post by ID.

## search
Syntax: `<rule34Py>.search([<tags>], <?limit>)`
- `tags` \<list> ([Tag Cheatsheet](https://rule34.xxx/index.php?page=tags&s=list))
- `limit` \<int> (Optional, Defaults is 100 and max limit is 100)
- returns: \<dictionary>


