pagpeter/matrix.py

Matrix.py

Matrix.py is a matrix bot library, inspired by the discord.py library by Rapptz. It is still in early beta, so don't expect it to be running smoothly yet.

It aims to be a modern, easy to use, feature-rich and async ready API wrapper for the Matrix system written in Python.

The documentation can be found here, examples can be found in the examples folder.

Installing

The package can be installed from pypi, via

$ pip install matrix-chat

You need to have gcc and the libolm package installed.

Quick Example

import matrix 

class MyClient(matrix.Client):
    def on_ready(self):
        print('Logged on as', self.user)

    def on_message(self, message: matrix.Message):
        # don't respond to ourselves
        if message.author == self.user:
            return

        print(f"[Room: {message.room.id}] {message.author}: {message.content}")

    def on_invite(self, invite: matrix.Invite):
        print(f"{invite.inviter} has invited you to join {invite.room_id}")

client = MyClient()
client.run(
    username='@bot:matrix.org',
    password='password',
    homeserver='https://matrix.org',
)

Limitations

• It is still in an early version - not tested enough
• Matrix.py doesn't yet support e2ee - it wont join or respond in encrypted rooms.