An easy to use bot library for the Matrix ecosystem written in Python.
Project description
Simple-Matrix-Bot-Lib
(Version 1.1.x)
simplematrixbotlib is a Python 3 library for quickly building Matrix bots. It uses matrix-nio as its Matrix client library. View on Github or View on PyPi
Installation
To use it, simplematrixbotlib can be either installed from pip or downloaded from github.
Installation from pip:
python -m pip install simplematrixbotlib
Download from github:
git clone --branch master 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 homeserver - Bots automatically login 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
-
Join room on invite - Bots automatically join rooms that the bot is invited to upon execution of bot.run(), or upon invite if the bot is running
In Progress:
-
N/A
Planned:
-
Execute action if messages meet criteria
-
Send message
-
More
Dependencies
Python:
-
matrix-nio >= 0.18.2
External:
-
Python >= 3.7
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
Built Distribution
Close
Hashes for simplematrixbotlib-1.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 3064307865cd4249beb073dae24b8c23b9f29b730594d958ef00a06577457658 |
|
MD5 | 0a6f2f37331200cd91897bb749498934 |
|
BLAKE2b-256 | 329f65da7d4dc67012559732455374f47634fc6da95d13d85763f9ae8fd92d5a |