Repository files navigation

Python class to easily develop a simple Telethon style chatbot for the LXMF protocol.

$ pip install -r requirements.txt

• Instantiate the class with aname for the bot as parameter.
  • Two additional options the class takes as parameters areannounce to define the announce interval in seconds (defaults to360) and anannounce_immediately boolean to define whether the bot should announce itself immediately after instantiation or not (defaults toFalse)
• Use thereceived decorator to define functions for parsing received messages
• Use the<instance>.send(recipient_hash, message) ormsg.reply(message) methods to send messages
• Launch the bot using therun method

Functions decorated byreceived have access to amsg parameter that has the following content:

• msg.sender : the sender hash address
• msg.content: the received message as utf-8 string
• msg.reply : function that takes a string parameter and sends it as reply to the sender
• msg.lxmf : the completeLXMessage object for more complex parsing

Example of a bot that echos a message back to the sender:

fromlxmfbotimportLXMFBotbot=LXMFBot("NodeBot")@bot.receiveddefecho_msg(msg):msg.reply(msg.content)bot.run()

The bots' identity and announce file location