cloudxtreme/txtelegrambot

Telegram Bot Service (unofficial) in Twisted Python 3

Telegram Bot Service (unofficial) in Twisted Python 3

A customisable bot for the Telegram Bot API written in Twisted Python 3

Uses:

• TelegramBotAPI: An implementation of the Telegram Bot API messages and some simple clients.
• pyPlugin: Simple framework-less plugin loader for Python.

Installation

pip3 install txTelegramBot

Usage

• Create a config.ini as follows, and set it up with your Telegram Bot API token, etc:

  [telegrambot]
  # Your Telegram Bot API token
  token = 123456:ABC-DEF1234ghIkl-zyx57W2v1u123ew11
  
  [proxy]
  # address = www.example.com:8080
  
  [message_plugins]
  1 = plugins/*.py
  # 2 = other/plugins/foo.py
  
  [env]
  # Set any additional environment variables your plugins may need
  BOT_NAME = txTelegramBot
  # FOO = bar
  

• Write a plugin using the following template and add it in the [message_plugins] section above:

  from twisted.internet import defer
  from TelegramBotAPI.types import sendMessage
  from TelegramBot.plugin.message import MessagePlugin
  
  
  class MyPlugin(MessagePlugin):
      def startPlugin(self):
          pass
  
      def stopPlugin(self):
          pass
  
      @defer.inlineCallbacks
      def on_message(self, msg):
          m = sendMessage()
          m.chat_id = msg.chat.id
          m.text = 'You said: %s' % msg.text
          rsp = yield self.send_message(m)
          defer.returnValue(True)
  

• Run the bot:

  $ twistd -n telegrambot -c config.ini