Metadata-Version: 2.1
Name: cunnypy
Version: 3.0.0
Summary: A blazingly fast image board library.
License: GPL-3.0-only
Keywords: allthefallen,anime,anime artwork,anyio,artwork,async,asyncio,booru,danbooru,e621,e926,gelbooru,hentai,httpx,hypnohub,konachan,library,lolibooru,parsel,realbooru,rule34,safebooru,sankaku,tbib,trio,xbooru,yandere
Author: CunnyArc
Author-email: glitchy@cunny.social
Requires-Python: >=3.11,<4.0
Classifier: Development Status :: 6 - Mature
Classifier: Framework :: AnyIO
Classifier: Framework :: AsyncIO
Classifier: Framework :: Trio
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.11
Classifier: Topic :: Games/Entertainment
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Multimedia
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Typing :: Typed
Requires-Dist: anyio (>=3.7.1,<4.0.0)
Requires-Dist: httpx (>=0.24.1,<0.25.0)
Requires-Dist: parsel (>=1.8.1,<2.0.0)
Project-URL: Documentation, https://codeberg.org/CunnyTech/Cunnypy#readme
Project-URL: Discord, https://discord.gg/ZxbYHEh
Project-URL: Funding, https://liberapay.com/Glitchy
Project-URL: Issues, https://codeberg.org/CunnyTech/Cunnypy/issues
Project-URL: Source, https://codeberg.org/CunnyTech/Cunnypy
Description-Content-Type: text/markdown

<h1 align="center">🦀 Cunny.py 🦀</h1>
<h3 align="center">🔥A Blazingly Fast Image Board Library🔥</h3>


---

<p align="center">
	<a href="#📥Installation">📥Installation</a> |
	<a href="#🌟Features">🌟Features</a> |
	<a href="#⚙️Usage">⚙️Usage</a>
</p>
<br>

## 📥Installation
✅ Getting started with Cunny.py is quick and easy! Simply install the package using your favorite tool.

📥Using [pip](https://pypi.org/project/pip/):

```bash
pip install cunnypy
```

🪶Using [poetry](https://python-poetry.org):

```bash
poetry add cunnypy
```

## 🌟Features
- 🔥 **Blazingly Fast**™️
- 🐍 **Modern** and **Pythonic** API.
- 🚀 Supports [**AnyIO**](https://github.com/agronholm/anyio), [**AsyncIO**](https://docs.python.org/3/library/asyncio.html), and [**Trio**](https://github.com/python-trio/trio).
- 💯 **15** boorus supported.
- 🆔 Support for **aliases**.
- 🎲 Randomize posts with the `gatcha` parameter.
- 🔍 Autocomplete support for **all** boorus.
- 🔢 Search **any combination** of boors at once.


## ⚙️Usage

### 🔎 Basic Search
📝 **Note**: You can specify additional parameters in the search function.

```python
import asyncio

import cunnypy


async def main():
    posts = await cunnypy.search("gelbooru", "megumin")
    print(posts)

asyncio.run(main())
```

### 🔍 Basic Multi-Booru Search
📝 **Note**: To add credential support import the `Booru` class.
```python
import asyncio

import cunnypy


async def main():
    posts = await cunnypy.ms(["gel", "safe"], "megumin")
    print(posts)

asyncio.run(main())
```

### 🤖 Autocomplete

```python
import asyncio

import cunnypy


async def main():
    auto = await cunnypy.autocomplete("gel", "megumi*")
    print(auto)

asyncio.run(main())
```

