مستندات SPlusthon¶
SPlusthon یک کتابخانه پایتون asyncio است که برای تعامل با API سروشپلاس طراحی شده است. این کتابخانه به شما امکان میدهد تا با استفاده از حساب کاربری خود، رباتها و اسکریپتهای مختلفی برای سروشپلاس بنویسید.
یادداشت
این مستندات فقط بخش UserBot را پوشش میدهد. اگر به دنبال مستندات ربات هستید، به بخش مربوطه مراجعه کنید.
چرا SPlusthon؟¶
- سادگی: API ساده و خوانا برای تعامل با سروشپلاس
- کارایی: پشتیبانی از asyncio برای عملیات همزمان
- امکانات گسترده: ارسال پیام، فایل، عکس و مدیریت مکالمات
- پشتیبانی از رویدادها: سیستم قدرتمند event برای پاسخ خودکار
- امنیت: ذخیرهسازی امن session و credentialها
بخشهای اصلی مستندات¶
-
:material-rocket-launch:{ .lg .middle } شروع سریع
راهنمای سریع برای شروع کار با SPlusthon در کمتر از ۵ دقیقه.
-
:material-cog:{ .lg .middle } نصب و راهاندازی
راهنمای نصب کتابخانه و وابستگیهای اختیاری.
-
:material-book-open-variant:{ .lg .middle } مفاهیم پایه
توضیحات جامع درباره مفاهیم اساسی مانند Entity، Session و رویدادها.
-
:material-code-braces:{ .lg .middle } مثالها
مثالهای عملی و کاربردی برای یادگیری بهتر.
-
:material-api:{ .lg .middle } مرجع API
مستندات کامل API کتابخانه.
-
:material-frequently-asked-questions:{ .lg .middle } سوالات متداول
پاسخ به سوالات رایج کاربران.
نمای کلی کتابخانه¶
from splusthon import SoroushClient, events
# ایجاد کلاینت
client = SoroushClient('session_name')
# ارسال پیام
await client.send_message('username', 'سلام!')
# گوش دادن به رویدادها
@client.on(events.NewMessage(pattern='(?i)سلام'))
async def handler(event):
await event.reply('سلام! خوش آمدید.')
پیشنیازها¶
- پایتون 3.7 یا بالاتر
- pip (آخرین نسخه)
- آشنایی مقدماتی با asyncio در پایتون