High-level Python Matrix library, with support for end-to-end encryption and persistence. Currently in early development, API can change anytime.
Requires Python 3.7 or later and olm 3 development headers installed on the system.
pip3 install -U --user .Install in editable mode and with dev dependencies:
pip3 install -U --user --editable '.[dev]'To run checks, from the project's root folder:
mypy . & flake8 . & python3 -m pytestUsing python3 -m pytest instead of pytest will ensure that the current
folder is added to import paths.
Arguments that can be added to the pytest command include:
- Paths to the files in tests/ to run, instead of running everything
--pdbto disable parallel testing and let debugger calls work normally--capture=no/-sto show logging output and prints in real time, combine with--pdb--covto generate test coverage info, terminal and HTML by default.
Don't pass file paths when using this flag, or the results will be incorrect.
Tests leave a Synapse server (which has a long startup time) running,
use synctl stop tests/synapse/homeserver.yaml to stop it.
The server's log is available at tests/synapse/homeserver.log.
import asyncio
from mio.client import Client
from mio.rooms.contents.messages import Text
from mio.rooms.contents.settings import Encryption
from mio.rooms.events import TimelineEvent
from mio.rooms.room import Room
from rich import print # pretty printing, installed as a dependency
def on_text_message(room: Room, event: TimelineEvent[Text]) -> None:
print(f"{room.id}: {event.sender}: {event.content.body} ({event.sending})")
async def main() -> None:
async with Client("/tmp/mio-example", "https://example.org") as client:
# Register a function that will be called when we receive Text events:
client.rooms.callbacks[TimelineEvent[Text]].append(on_text_message)
if await client.was_saved:
await client.load()
else:
await client.auth.login_password("alice", "1234")
# Sync with the server to update the client's state:
await client.sync.once()
# Create a room and sync to make it available in client.rooms:
room_id = await client.rooms.create("mio example room")
await client.sync.once()
# Enable encryption in the room and send a text message:
await client.rooms[room_id].state.send(Encryption())
await client.rooms[room_id].timeline.send(Text("Hello world"))
await client.sync.once()
# Explore our room's state and timeline:
print(client.rooms[room_id].state, end="\n\n")
print(client.rooms[room_id].timeline)
asyncio.run(main())