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.3)

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.3.tar.gz (9.6 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.3-py3-none-any.whl (11.0 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: simplematrixbotlib-2.6.3.tar.gz
  • Upload date:
  • Size: 9.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.8.12 Linux/5.16.14-051614-generic

File hashes

Hashes for simplematrixbotlib-2.6.3.tar.gz
Algorithm Hash digest
SHA256 77126425c329d8316666ab061e57a6817432f785601fa955a8831e442e174ace
MD5 32020e2958e3e4acddd9983550b2fa0e
BLAKE2b-256 7dc36d7c0e9bd82702cd5fd3ad2d9a758715ce41b0280e76a271d4ea204bfdb8

See more details on using hashes here.

File details

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

File metadata

  • Download URL: simplematrixbotlib-2.6.3-py3-none-any.whl
  • Upload date:
  • Size: 11.0 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.1.13 CPython/3.8.12 Linux/5.16.14-051614-generic

File hashes

Hashes for simplematrixbotlib-2.6.3-py3-none-any.whl
Algorithm Hash digest
SHA256 4125a36e6a9e772e78106798fc8f31a07fd200380bf8f06f204a927756fcff54
MD5 b01f24a71f29a4defa99a4a9cea7c754
BLAKE2b-256 fd55d5b5d0644742d2b5f3b73a481aa905a5edcf74bb187d185a79f9dd053b5d

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