An easy to use bot library for the Matrix ecosystem written in Python.
Project description
Simple-Matrix-Bot-Lib
(Version 2.10.0)
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.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
simplematrixbotlib-2.10.0.tar.gz
(14.2 kB
view hashes)
Built Distribution
Close
Hashes for simplematrixbotlib-2.10.0.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 8c1cd5a392facd6535a01109ab8f6560371d2bcff7ac6cf1f474fec9934cc12e |
|
MD5 | c17c849fa428b697c8bf117a8131bb35 |
|
BLAKE2b-256 | 3b444223749fc57edd2eed8b7172932a0d1aa5827dd2b32fa6ab078fd8bad22a |
Close
Hashes for simplematrixbotlib-2.10.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 7bfea5798053f416ac427159bb8b04394f24b2445bf32f6b4669aaff461b06ad |
|
MD5 | 34a36ae948b9ef90698698ca99726499 |
|
BLAKE2b-256 | 0126fe13499f39f3cbf93506a0de5268651eb7512ca0929d36dcd02aa8ccf93b |