Simple-Matrix-Bot-Lib
(Version 2.12.1)
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.
1 maintainer
Metadata
1 maintainer
Release files for simplematrixbotlib 2.12.1
For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.
Source distribution (sdist)
| File | Size | Uploaded | |
|---|---|---|---|
| simplematrixbotlib-2.12.1.tar.gz | 15.9 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| simplematrixbotlib-2.12.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 33.9 kB
Release files / simplematrixbotlib-2.12.1.tar.gz
| Download URL | simplematrixbotlib-2.12.1.tar.gz |
|---|---|
| Size | 15.9 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
f5e30caf6a8cf1c94887790cc487da47a6dab4718cc2b34351e4a7e4ffc627be
|
|
BLAKE2b-256 checksum How to use checksums |
cc901d38b24a0ade611d1031974c28e232530ca99b495f79e67ec1379cbc440b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.5 CPython/3.13.0 Linux/6.6.51-0-virt
|
Release files / simplematrixbotlib-2.12.1-py3-none-any.whl
| Download URL | simplematrixbotlib-2.12.1-py3-none-any.whl |
|---|---|
| Size | 18.0 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
1a508056a291ae1bf23fc3f99aa41b656e3fa160da4244e03da29f36dc5d7a29
|
|
BLAKE2b-256 checksum How to use checksums |
1a88bc090434107c7e97bddc414ed7e7fc8997e38d4342125b7f7da759041b4e
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/1.8.5 CPython/3.13.0 Linux/6.6.51-0-virt
|
