Metadata-Version: 2.4
Name: nicotin
Version: 0.1.3
Summary: An async Rubika library with a Pyrogram-style API.
License: MIT License
        
        Copyright (c) 2026 NICOTIN contributors
        
        Permission is hereby granted, free of charge, to any person obtaining a copy
        of this software and associated documentation files (the "Software"), to deal
        in the Software without restriction, including without limitation the rights
        to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
        copies of the Software, and to permit persons to whom the Software is
        furnished to do so, subject to the following conditions:
        
        The above copyright notice and this permission notice shall be included in all
        copies or substantial portions of the Software.
        
        THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
        IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
        FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
        AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
        LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
        OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
        SOFTWARE.
        
Keywords: rubika,rubika-bot,rubika-api,bot,async,telegram-style,pyrogram-style
Classifier: Development Status :: 3 - Alpha
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3 :: Only
Classifier: Programming Language :: Python :: 3.10
Classifier: Programming Language :: Python :: 3.11
Classifier: Programming Language :: Python :: 3.12
Classifier: Framework :: AsyncIO
Classifier: Topic :: Software Development :: Libraries
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Requires-Python: >=3.10
Description-Content-Type: text/markdown
License-File: LICENSE
Requires-Dist: httpx>=0.24
Dynamic: license-file

# NICOTIN

یک کتابخانه‌ی async برای **بات‌های روبیکا (Rubika Bot API)** که **عمداً** از نظر نام متدها، پراپرتی‌ها، فیلترها، ساختار Handler و حتی سبک مستندات، شبیه کتابخانه‌های معروف تلگرام (به‌خصوص Pyrogram) طراحی شده — تا هر کسی که با بات‌نویسی تلگرام آشناست، بدون یادگیری از صفر بتواند برای روبیکا هم بات بنویسد.

> این کتابخانه برای **بات** ساخته شده و فقط با **bot token** کار می‌کند (همون توکنی که از `@rubika_bot` می‌گیری) — نه با اکانت شخصی و session/auth. یعنی نیازی به لاگین با شماره موبایل و کد تأیید نیست.

نصب از PyPI (بعد از انتشار پکیج):

```bash
pip install nicotin
```

نصب توسعه‌ای از روی سورس (قبل از انتشار، یا برای مشارکت در توسعه):

```bash
git clone <repo-url>
cd nicotin
pip install -e .
```

## شروع سریع

```python
from nicotin import Client, filters

app = Client(bot_token="123456:AbCdEfGhIjKlMnOpQrStUvWxYz")

@app.on_message(filters.command("start"))
async def start(client, message):
    await message.reply("سلام از نیکوتین 👋")

@app.on_message(filters.text & filters.private)
async def echo(client, message):
    await message.reply(message.text)

app.run()
```

توکن بات رو از **@rubika_bot** توی خود روبیکا با ساختن یک بات جدید می‌گیری.

## ساختار پروژه (مثل Pyrogram)

```
nicotin/
├── client.py        # کلاس Client — متدهای send_message, send_photo, edit_message_text, ...
├── types/            # Message, User, Chat, File, CallbackQuery, Update
├── filters.py        # filters.text, filters.command(), filters.regex(), ترکیب با & | ~
├── handlers/          # MessageHandler, CallbackQueryHandler, ...
├── enums/             # ChatType, MessageType, ChatActivity, ParseMode
├── errors/            # NicotinError, RPCError, FloodWait, AuthError, ...
└── network/            # Session — لایه‌ی ارتباط HTTP با Bot API روبیکا (توکن در URL، JSON ساده)
```

## نگاشت متدها (Telegram ↔ Rubika)

| در NICOTIN | مشابه در Pyrogram | چه کاری می‌کند در روبیکا |
|---|---|---|
| `Client.get_me()` | همنام | گرفتن اطلاعات خود بات |
| `Client.send_message()` | همنام | ارسال پیام متنی |
| `Client.send_photo()` / `send_video()` / `send_document()` | همنام | ارسال رسانه (آپلود + ارسال) |
| `Client.edit_message_text()` | همنام | ویرایش پیام |
| `Client.delete_messages()` | همنام | حذف پیام(های) خود بات |
| `Client.forward_messages()` | همنام | فوروارد پیام |
| `Client.get_chat()` / `get_chat_history()` | همنام | اطلاعات چت / تاریخچه پیام‌ها |
| `Client.set_webhook()` | `set_webhook` | ثبت آدرس webhook به‌جای long-polling |
| `message.reply()` / `.edit_text()` / `.delete()` | همنام | shortcutهای روی خود پیام |
| `filters.text/photo/command()` | همنام | فیلتر روی نوع/محتوای پیام |
| `@app.on_message()` / `@app.on_callback_query()` | همنام | ثبت هندلر |

**نکته:** چون این کتابخانه فقط bot token می‌گیرد نه اکانت شخصی، متدهای مدیریت گروه که نیاز به دسترسی ادمین یک اکانت واقعی دارند (مثل ban/unban عضو، leave گروه) در این نسخه وجود ندارند — این‌ها خارج از قابلیت‌های استاندارد Bot API هستند.

## نکته‌ی مهم درباره‌ی لایه‌ی شبکه

`nicotin/network/session.py` روی **Bot API رسمی روبیکا** پیاده شده: توکن بات داخل مسیر URL قرار می‌گیره و بدنه‌ی درخواست/پاسخ JSON ساده است — برخلاف API اکانت شخصی (session-based) که رمزنگاری AES و لاگین با شماره تلفن لازم داره، اینجا هیچ‌کدوم از این پیچیدگی‌ها وجود نداره.

## مجوز

MIT — فایل [LICENSE](./LICENSE) رو ببین.
