Skip to main content

An easy to use bot library for the Matrix ecosystem written in Python.

Project description

Simple-Matrix-Bot-Lib

(Version 2.6.2)

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.

Installation

simplematrixbotlib can be either installed from PyPi or downloaded from github.

Installation from PyPi:

python -m pip install simplematrixbotlib

Download from github:

git clone --branch master https://github.com/KrazyKirby99999/simple-matrix-bot-lib.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


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.6.2.tar.gz (9.5 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

simplematrixbotlib-2.6.2-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

Details for the file simplematrixbotlib-2.6.2.tar.gz.

File metadata

  • Download URL: simplematrixbotlib-2.6.2.tar.gz
  • Upload date:
  • Size: 9.5 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.2 Linux/5.16.11-arch1-1

File hashes

Hashes for simplematrixbotlib-2.6.2.tar.gz
Algorithm Hash digest
SHA256 f890e42773f4ab64598816b8c4916c000850586a4eb529da1df5c26e44057d48
MD5 7ba6d1262cbaae5374fd9fe61ad64a37
BLAKE2b-256 5b135965e7ce1517d5deb6357eaeac01ead2fe8a661938d1b4bc0ab65142d020

See more details on using hashes here.

File details

Details for the file simplematrixbotlib-2.6.2-py3-none-any.whl.

File metadata

  • Download URL: simplematrixbotlib-2.6.2-py3-none-any.whl
  • Upload date:
  • Size: 10.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.12 CPython/3.10.2 Linux/5.16.11-arch1-1

File hashes

Hashes for simplematrixbotlib-2.6.2-py3-none-any.whl
Algorithm Hash digest
SHA256 9d878194cadf15af38a91dc1ccdb5bb3e25f97021c1bfd747d6032b003fe7942
MD5 82e31caba61fd153f28bf826558e05e2
BLAKE2b-256 c3f2ad33f6e66c0d07beca96fa88d9b2dee2f2059c9abe12dbc5fb9228c20451

See more details on using hashes here.

Supported by

AWS Cloud computing and Security Sponsor Datadog Monitoring Depot Continuous Integration Fastly CDN Google Download Analytics Pingdom Monitoring Sentry Error logging StatusPage Status page