Simple-Matrix-Bot-Lib

(Version 2.9.1)

Simple-Matrix-Bot-Lib is a Python bot library for the Matrix ecosystem built on matrix-nio.

View on Github or View on PyPi or View docs on readthedocs.io

Learn how you can contribute here.

Features

hands-off approach: get started with just 10 lines of code (see example)
end-to-end encryption support
limited verification support (device only)
easily extensible config file
user access management
access the matrix-nio library to use advanced features

Installation

simplematrixbotlib can be either installed from PyPi or downloaded from github.

Installation from PyPi:

python -m pip install simplematrixbotlib

Read the docs to learn how to install E2E encryption support.

Download from github:

git clone --branch master https://github.com/i10b/simplematrixbotlib.git

Example Usage

# echo.py
# Example:
# randomuser - "!echo example string"
# echo_bot - "example string"

import simplematrixbotlib as botlib

creds = botlib.Creds("https://home.server", "echo_bot", "pass")
bot = botlib.Bot(creds)
PREFIX = '!'

@bot.listener.on_message_event
async def echo(room, message):
    match = botlib.MessageMatch(room, message, bot, PREFIX)

    if match.is_not_from_this_bot() and match.prefix() and match.command("echo"):

        await bot.api.send_text_message(
            room.room_id, " ".join(arg for arg in match.args())
            )

bot.run()

More information and examples can be found here.

Metadata

Release files for simplematrixbotlib 2.9.1

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for simplematrixbotlib 2.9.1
File	Size	Uploaded
simplematrixbotlib-2.9.1.tar.gz	14.1 kB	Jul 25, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for simplematrixbotlib 2.9.1
File	Interpreter	ABI	Platform	Reset
simplematrixbotlib-2.9.1-py3-none-any.whl 16.2 kB Jul 25, 2023	Python 3	none	any	Details

Total release size: 30.3 kB

Release files / simplematrixbotlib-2.9.1.tar.gz

Download URL	simplematrixbotlib-2.9.1.tar.gz
Size	14.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`d7f15a3f75b760598a315438b6dedcf969bd651985932c069e6a42d6faa84e0f`
BLAKE2b-256 checksum How to use checksums	`9a642bad2197eed78bd6102c3689d2b06873c4b0701bf6629e9eb7db00f0c28d`
Upload date	Jul 25, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.4.2 CPython/3.10.10 Linux/6.3.9-1-default`

Release files / simplematrixbotlib-2.9.1-py3-none-any.whl

Download URL	simplematrixbotlib-2.9.1-py3-none-any.whl
Size	16.2 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`e52873979b1c6d858c0100fec19a9cfc75c174c5702c4e4d61e599eb4d6e64ab`
BLAKE2b-256 checksum How to use checksums	`ab8530485bff5c7ad5af397bbccb12b8fd4d71e984edaae250ae7f58c5985690`
Upload date	Jul 25, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.4.2 CPython/3.10.10 Linux/6.3.9-1-default`