simplematrixbotlib 1.2.0

An easy to use bot library for the Matrix ecosystem written in Python.

Simple-Matrix-Bot-Lib

(Version 1.2.x)

simplematrixbotlib is a Python 3 library for quickly building Matrix bots. It uses matrix-nio as its Matrix client library. View on Github or View on PyPi

Installation

To use it, simplematrixbotlib can be either installed from pip or downloaded from github.

Installation from pip:

python -m pip install simplematrixbotlib

Download from github:

git clone --branch master https://github.com/KrazyKirby99999/simple-matrix-bot-lib.git

Example Usage

import simplematrixbotlib as botlib

creds = botlib.Creds("home.server", "user", "pass")
bot = botlib.Bot(creds)
bot.run()

Features

Complete:

• Login to homeserver - bot automatically login upon the execution of bot.run()

  import simplematrixbotlib as botlib
  
  creds = botlib.Creds("home.server", "user", "pass")
  bot = botlib.Bot(creds)
  bot.run() #Logs in during the execution of this line
  

• Join room on invite - bot automatically join rooms that the bot is invited to upon execution of bot.run(), or upon invite if the bot is running

• Send message - bot can send messages in response to other messages, and can also run other code in response to messages as well as filter the messages that the bot responds to

  import simplematrixbotlib as botlib
  
  creds = botlib.Creds("home.server", "user", "pass")
  bot = botlib.Bot(creds)
  
  async def say_something_to_a_message_not_from_bot(room, message): #Must be an "async" function with (room, message) arguments
      if not message.sender == bot.async_client.user_id: #Optional, prevents the bot from reacting to its own messages
          await bot.api.send_text_message(room.room_id, "something") #Send a message containing "something" to room
  bot.add_message_listener(say_something_to_a_message_not_from_bot) #Listen for messages, can have as many message listeners as needed, each added using bot.add_message_listener
  
  bot.run()
  

In Progress:

• Execute action based on criteria

Planned:

• More

Dependencies

Python:

• matrix-nio >= 0.18.2

External:

• Python >= 3.7