An easy to use bot library for the Matrix ecosystem written in Python. https://matrix.to/#/#simplematrixbotlib:matrix.org

576 commits 6 branches 44 tags 892 KiB

Python 100%

Find a file

saces d1d62eecd3 version v2.42.27		2025年04月02日 21:06:23 +02:00
.github	ci: 👷 Remove manual pip install pytest-github-actions-annotate-failures from pytest workflow	2021年12月31日 13:46:13 -06:00
doc	Add notice to readthedocs	2024年07月03日 18:31:11 -05:00
examples	Add reply_to param in api.send_text_message. Also add usage example. ( #47 )	2024年02月20日 22:19:15 +00:00
simplematrixbotlib	allow invalid configuration, useful in some rare special use cases.	2025年04月02日 21:02:15 +02:00
tests	Fix unit tests ( #92 )	2024年08月31日 00:07:28 +00:00
.gitignore	add .venv to gitignore	2024年11月30日 12:17:33 +01:00
CHANGELOG.md	Release 2.12.0	2024年07月24日 10:12:31 -05:00
CONTRIBUTING.md	Update references from Github to Codeberg repository ( #82 )	2024年06月05日 12:49:05 +00:00
LICENSE	Update LICENSE	2023年10月21日 13:21:28 +00:00
pyproject.toml	version v2.42.27	2025年04月02日 21:06:23 +02:00
README.md	Release 2.12.0	2024年07月24日 10:12:31 -05:00

README.md

Simple-Matrix-Bot-Lib

(Version 2.12.0)

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

View on Codeberg 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 Codeberg.

Installation from PyPi:

python -m pip install simplematrixbotlib

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

Download from Codeberg:

git clone --branch master https://codeberg.org/imbev/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.