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

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.0.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.0-py3-none-any.whl (10.9 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for simplematrixbotlib-2.6.0.tar.gz
Algorithm Hash digest
SHA256 0b46f2d394a42dd4c4aaade61b39ff6baf1ca6bdd1549254a2a5e258bebc1c06
MD5 2527fea109c48e0c4ec6031a13824861
BLAKE2b-256 064dbbeee684937f1f3b860c3c0299b8ab91203291d35132e0864353e684ec40

See more details on using hashes here.

File details

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

File metadata

  • Download URL: simplematrixbotlib-2.6.0-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.1 Linux/5.15.13-arch1-1

File hashes

Hashes for simplematrixbotlib-2.6.0-py3-none-any.whl
Algorithm Hash digest
SHA256 fc418d5785ca62735d2856e7a185f9ab73880cb5da9d956373d395b0e2d7ff96
MD5 9775d86b1c4a193b29864a12ac5c5698
BLAKE2b-256 cb55c1b7ef8c41eb05e4f2388995088685380ed2c48078f1d20aefc55966ad25

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