Simple-Matrix-Bot-Lib
(Version 2.13.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.
1 maintainer
Release files for simplematrixbotlib 2.13.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.13.1.tar.gz | 15.7 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| simplematrixbotlib-2.13.1-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 34.0 kB
Release files / simplematrixbotlib-2.13.1.tar.gz
| Download URL | simplematrixbotlib-2.13.1.tar.gz |
|---|---|
| Size | 15.7 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
e6798f1d5f1594f23b46256a93625b16e2ae17f65bc91190bc65da7c07269582
|
|
BLAKE2b-256 checksum How to use checksums |
b6710555b93b25745b629f8088c11e5966430155f9771ad6513b100740ff0267
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.2 CPython/3.12.12 Linux/6.12.0-124.45.1.el10_1.x86_64
|
Release files / simplematrixbotlib-2.13.1-py3-none-any.whl
| Download URL | simplematrixbotlib-2.13.1-py3-none-any.whl |
|---|---|
| Size | 18.3 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
4355f22869085f6a7b3c3dc631298526bdd5dbce0d9c8f3ab77bcb9eca8b288d
|
|
BLAKE2b-256 checksum How to use checksums |
d58bcb9cf66ba6e081410b0cb576cfe0c4a68afb25a427d2271e300edc94b07b
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.3.2 CPython/3.12.12 Linux/6.12.0-124.45.1.el10_1.x86_64
|
