Simple-Matrix-Bot-Lib

(Version 2.10.3)

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.10.3

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.10.3
File	Size	Uploaded
simplematrixbotlib-2.10.3.tar.gz	14.1 kB	Dec 15, 2023	Details

Built distribution (wheel)

Table of built distributions (wheels) for simplematrixbotlib 2.10.3
File	Interpreter	ABI	Platform	Reset
simplematrixbotlib-2.10.3-py3-none-any.whl 16.3 kB Dec 15, 2023	Python 3	none	any	Details

Total release size: 30.4 kB

Release files / simplematrixbotlib-2.10.3.tar.gz

Download URL	simplematrixbotlib-2.10.3.tar.gz
Size	14.1 kB
Tags	Source
SHA-256 checksum How to use checksums	`3218f63e2dd8b483c459a7fe8d8b6e80e793ba4ac75974ca619e1713de0ecf81`
BLAKE2b-256 checksum How to use checksums	`c313d4d6959e600275907698d62de686e850fc19b97fc35c052bbaa6b74da99d`
Upload date	Dec 15, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.7.1 CPython/3.11.6 Linux/6.6.3-200.fc39.x86_64`

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

Download URL	simplematrixbotlib-2.10.3-py3-none-any.whl
Size	16.3 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`3cb3151ce1bab259ea5746b660032f1e270ac54da9fd419cc0044ac90ef2f853`
BLAKE2b-256 checksum How to use checksums	`af82e934fbcd506b7819f449dc881a48db2e03b31d1e803147ca5ca03794de00`
Upload date	Dec 15, 2023
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`poetry/1.7.1 CPython/3.11.6 Linux/6.6.3-200.fc39.x86_64`