Skip to main content

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

Project description

Simple-Matrix-Bot-Lib

(Version 1.0.x)

simplematrixbotlib is a Python 3 library for quickly building Matrix bots. It uses matrix-nio as its Matrix client library.

Installation

To use it, simplematrixbotlib can be either installed from pip or downloaded from github.

Installation from pip:

python -m pip install simplematrixbotlib

Installation from github:

git clone https://github.com/KrazyKirby99999/simple-matrix-bot-lib.git

Example Usage

import simplematrixbotlib as botlib

creds = botlib.Creds("home.server", "user", "pass")
bot = botlib.Bot(creds)
bot.run()

Features

Complete:

  • Login to Matrix - Bots automatically login to matrix upon the execution of bot.run()

    import simplematrixbotlib as botlib
    
    creds = botlib.Creds("home.server", "user", "pass")
    bot = botlib.Bot(creds)
    bot.run() #Logs in during the execution of this line
    

In Progress:

  • N/A

Planned:

  • Join room on invite

  • Execute action if messages meet criteria

  • Send message

  • More

Dependencies

Python:

  • matrix-nio >= 0.18.2

External:

  • Python >= 3.7

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-1.0.1.tar.gz (2.7 kB view hashes)

Uploaded Source

Built Distribution

simplematrixbotlib-1.0.1-py3-none-any.whl (3.3 kB view hashes)

Uploaded Python 3

Supported by

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