README.md

Frappe Telegram

Telegram Bot Manager for Frappe. This is a wrapper around python-telegram-bot tuned for frappe. Please go through the documentations of python-telegram-bot to easily customize your bot.

Features

• Frappe Context for each incoming Updates
• Multi Bot support
• Runs the bot independently from the web server process
• Custom Bot implementations via Hooks
• Frappe User Login
• Frappe User signup
• Tracks Chats and contained messages
• Supports sending messages from bot via frappe hooks / controller methods
• Integration with frappe Notification doctype

DocTypes

• Telegram Bot
  Add all your telegram-bots here with their api-tokens
• Telegram User
  Any telegram-user that interacts with your bot comes here. Authentication is when Telegram User is linked to frappe's User
• Telegram Chat
  All private chats, groups where the bot gets notified comes here
• Telegram Message
  All messages - incoming & outgoing gets logged here

Page

• Telegram Chat View
  A simple chat-page within frappe just for your telegram-bots

Guides

• Basic Setup
• User Authentication
• Running in DEV mode
• Supported Hooks for Customization
• Setting up for Production
• Using Frappe Notifications DocType
• Meta Conversation Driver
• Example: Login Notifier
• Example: Activity Notifier

License

MIT