Simple-Matrix-Bot-Lib
(Version 2.12.3)
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.3
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.3.tar.gz | 15.6 kB | Details |
Built distribution (wheel)
| File | Interpreter | ABI | Platform | Reset |
|---|---|---|---|---|
| simplematrixbotlib-2.12.3-py3-none-any.whl | Python 3 | none | any | Details |
Total release size: 33.7 kB
Release files / simplematrixbotlib-2.12.3.tar.gz
| Download URL | simplematrixbotlib-2.12.3.tar.gz |
|---|---|
| Size | 15.6 kB |
| Tags | Source |
|
SHA-256 checksum How to use checksums |
ed04e16877cdd66a635086ef6e4f30d0f5337db01fc8ec982e6c5cd2920029c1
|
|
BLAKE2b-256 checksum How to use checksums |
a9fe6cb6f4364bcf55b13d60325b76ea74758001a0009a93f6a0e979159a3816
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.0.1 CPython/3.12.8 Linux/6.12.0-41.el10.x86_64
|
Release files / simplematrixbotlib-2.12.3-py3-none-any.whl
| Download URL | simplematrixbotlib-2.12.3-py3-none-any.whl |
|---|---|
| Size | 18.1 kB |
| Tags | Python 3 |
|
SHA-256 checksum How to use checksums |
99653f2b179feb15b333c88cb5915ab2f6454c26a71ffffb51b400ac1a238c54
|
|
BLAKE2b-256 checksum How to use checksums |
c365e383454ad44cee95fcec3c5e28b5a28fefd4f3a5bec21e28dc4c9772a321
|
| Upload date | |
|
Uploaded using Trusted Publishing? What is trusted publishing? |
No |
| Uploaded via |
poetry/2.0.1 CPython/3.12.8 Linux/6.12.0-41.el10.x86_64
|
