mindroom-nio 0.25.4

A Python Matrix client library, designed according to sans I/O principles.

mindroom-nio

This fork exists primarily because I need vodozemac-backed E2EE support for MindRoom, which relies heavily on nio. libolm is officially deprecated, and the python-olm wheels currently stop at CPython 3.12, making the old dependency path a poor fit for newer Python versions. This fork keeps that support, plus a small set of other useful pending upstream PRs, available in a published package while upstream activity is quiet. I would be happy to see the upstream project become active again and reduce fork-specific maintenance over time.

mindroom-nio is a fork of nio, a multilayered Matrix client library. The distribution name is mindroom-nio; the Python import name remains nio. The underlying base layer doesn't do any network IO on its own, but on top of that is a full-fledged batteries-included asyncio layer using aiohttp. File IO is only done if you enable end-to-end encryption (E2EE).

Documentation

The full API documentation for nio can be found at https://matrix-nio.readthedocs.io

Features

nio has most of the features you'd expect in a Matrix library, but it's still a work in progress.

• ✅ transparent end-to-end encryption (EE2E)
• ✅ encrypted file uploads & downloads
• ✅ space parents/children
• ✅ manual and emoji verification
• ✅ custom authentication types
• ✅ threading support
• ✅ well-integrated type system
• ✅ knocking, kick, ban and unban
• ✅ typing notifications
• ✅ message redaction
• ✅ token based login
• ✅ user registration
• ✅ read receipts
• ✅ live syncing
• ✅ m.reactions
• ✅ m.tags
• ❌ cross-signing support
• ❌ server-side key backups (room key backup, "Secure Backup")
• ❌ user deactivation (#112)
• ❌ in-room emoji verification

Installation

To install mindroom-nio, simply use pip:

$ pip install mindroom-nio

Note that this installs mindroom-nio without end-to-end encryption support. The e2ee enabled version can be installed using pip:

$ pip install "mindroom-nio[e2e]"

Additionally, a docker image with the e2ee enabled version of nio is provided in the docker/ directory.

Examples

For examples of how to use nio, and how others are using it, read the docs