روبیکا API هایی در اختیار کاربران قرار می‌دهد که با استفاده از آنها می‌توانید «بات» خودتان را بسازید، بنابراین:

کتابخانه روبپای یک فریم‌ورک مدرن پایتون برای ساخت ربات‌های پیام‌رسان روبیکا است. برای استفاده از آن، باید پایتون ۳ و ابزار پیپ را روی سیستم خود نصب داشته باشید. توصیه می‌کنیم از آخرین نسخه‌های پایدار استفاده کنید.

✨ چرا روبپای؟¶

📦 آماده — نصب از طریق pip و آغاز استفاده در کمترین زمان
🧠 ساده — ساختاری تمیز، قابل فهم و مناسب برای مبتدیان
💅 زیبا — انتزاع دقیق و هوشمندانه‌ی جزئیات سطح پایین
🚀 سریع — استفاده از فناوری های مدرن و کدنویسی بهینه
🔁 اولویت با Async — طراحی کاملاً غیرهمزمان همراه با پشتیبانی از حالت همزمان
💪 قدرتمند — ارائه‌ی تمامی قابلیت‌های کلاینت رسمی، API بات روبیکا و فراتر از آن

👀 مراحل استفاده¶

با استفاده از @BotFather در روبیکا یک بات بسازید، سپس توکن دریافتی را کپی کنید و در باقی مراحل از آن استفاده کنید.

🧰 نصب روبپای¶

ساده‌ترین روش برای نصب یا به‌روزرسانی روبپای به آخرین نسخه پایدار، استفاده از دستور زیر است:

pip3 install -U rubpy

🚀 نسخه توسعه (Bleeding Edge)¶

برای نصب آخرین نسخه توسعه‌یافته از مخزن گیت‌هاب:

pip3 install -U https://github.com/shayanheidari/rubika/archive/master.zip

✅ اطمینان از نصب موفق¶

برای اطمینان از اینکه روبپای به درستی نصب شده است، یک شل پایتون باز کرده و کد زیر را اجرا کنید:

import rubpy
print(rubpy.__version__)

اگر خطایی دریافت نکردید، نصب موفقیت‌آمیز بوده است.

🍀 یک تست ساده¶

ابتدا با استفاده از توکنی که از BotFather دریافت کرده‌ایم، با استفاده از کتابخانه روبپای یک بات ساده طراحی می‌کنیم:

from rubpy.bot import BotClient, filters
from rubpy.bot.models import Update

app = BotClient("your-bot-token")


@app.on_update(filters.text, filters.private)
async def echo(client, update: Update):
    await update.reply(update.new_message.text)


app.run()  # Automatically start()

در این مثال، بات ما هر پیام جدیدی را که در PV دریافت کند، پردازش می‌کند و همان پیام را باز ارسال می‌کند.

البته زمانی که شما از حالت Long-Polling استفاده می‌کنید، ممکن است بات با کمی تاخیر آپدیت‌های جدید را دریافت کند، اما وقتی که endpointهای خود را تنظیم می‌کنید و از روش وب‌هوک استفاده می‌کنید، بات با حداکثر سرعت و بدون تاخیر پاسخگو خواهد بود. در واقع روش لانگ پولینگ مناسب بات‌های کوچک خواهد بود.

💡 توسعه‌دهنده¶

این پروژه توسط شایان حیدری توسعه داده شده است. خوشحال می‌شویم اگر باگ‌ها، پیشنهادات و مشارکت‌های خود را از طریق Issues یا Pull Requests در گیت هاب با ما در میان بگذارید.

📬 ارتباط¶

برای دریافت نکات برنامه‌نویسی و اخبار روبپای می‌توانید در خبرنامه ما در روبیکا عضو شوید.

🛡 لایسنس¶

این پروژه تحت لایسنس GNU V3.0 منتشر شده است. برای اطلاعات بیشتر به فایل لایسنس مراجعه کنید.