Metadata-Version: 2.1
Name: py-Puii
Version: 2022.6.6
Summary: A Secure and Powerful Python-Telethon Based Library For Puii Userbot.
Home-page: https://github.com/AellyXD/pyPuii
Author: AellyXD
Author-email: itsme.ananya47@gmail.com
License: GNU AFFERO GENERAL PUBLIC LICENSE (v3)
Project-URL: Bug Tracker, https://github.com/AellyXD/pyPuii/issues
Project-URL: Documentation, https://t.me/kkara9009
Project-URL: Source Code, https://github.com/AellyXD/pyPuii
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.8
Classifier: Programming Language :: Python :: 3.9
Classifier: Programming Language :: Python :: 3.10
Classifier: License :: OSI Approved :: GNU General Public License v3 (GPLv3)
Classifier: Operating System :: OS Independent
Requires-Python: >3.7, <3.11
Description-Content-Type: text/markdown
License-File: LICENSE

# py-Puii Library

# Installation
```bash
pip3 install -U py-Puii
```


# Usage
- Create folders named `plugins`, `addons`, `assistant` and `resources`.   
- Add your plugins in the `plugins` folder and others accordingly.   
- Create a `.env` file with following mandatory Environment Variables
   ```
   API_ID
   API_HASH
   SESSION
   REDIS_URI
   REDIS_PASSWORD
   ```
- Check
[`.env.sample`](https://github.com/AellyXD/Puii/blob/main/.env.sample) for more details.   
- Run `python3 -m pyPuii` to start the bot.   

## Creating plugins
 - ### To work everywhere

```python
@puii_cmd(
    pattern="start"
)   
async def _(e):   
    await e.eor("Puii Started!")   
```

- ### To work only in groups

```python
@puii_cmd(
    pattern="start",
    groups_only=True,
)   
async def _(e):   
    await eor(e, "Puii Started.")   
```

- ### Assistant Plugins 👇

```python
@asst_cmd("start")   
async def _(e):   
    await e.reply("Puii Started.")   
```
