Skip to main content

mindroom-nio

Build Status PyPI - Python Version codecov license Documentation Status #nio

MindRoom Logo

This fork publishes the Matrix nio changes needed by MindRoom on a release schedule independent of upstream matrix-nio. It follows active upstream development closely and carries a focused set of additions, primarily bot-oriented E2EE behavior, reliability fixes, and Simplified Sliding Sync support that are not yet available in an upstream release. Generally useful changes are kept suitable for upstream contribution, while fork-specific packaging and policy remain clearly separated.

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

Fork-specific authenticated custom to-device transport supports pinned application messages and durable device-only consumers.

Fork-specific room payload encryption and ephemeral events let an application encrypt a room event without sending it and send MSC2477 ephemeral room events.

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 (fork addition; bot-scoped producer side — self-signs the account's own device so it stays usable under MSC4153. The verifier side, Secret Storage, and key backup are not implemented. See doc/cross-signing.md.)
  • ❌ 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

Metadata

Release files for mindroom-nio 1.3.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for mindroom-nio 1.3.0
File Size Uploaded Provenance Actions
mindroom_nio-1.3.0.tar.gz 221.0 kB With provenance Details for mindroom_nio-1.3.0.tar.gz

Built distribution (wheel)

Table of built distributions (wheels) for mindroom-nio 1.3.0
File Interpreter ABI Platform Actions
mindroom_nio-1.3.0-py3-none-any.whl Python 3 none any Details for mindroom_nio-1.3.0-py3-none-any.whl

Total release size: 478.2 kB

Release files / mindroom_nio-1.3.0.tar.gz

Download URL mindroom_nio-1.3.0.tar.gz
Size 221.0 kB
Tags Source
SHA-256 checksum
How to use checksums
4840d972a5c60e85107d37b0148059b5d2db60b6ff5ae7ba83716ba8f18700b3
BLAKE2b-256 checksum
How to use checksums
c07f333c85639d67fa666e4f2b4622307fc260208f8f79c5430106f11a7b21f8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 31, 2026.

Transparency log

Release files / mindroom_nio-1.3.0-py3-none-any.whl

Download URL mindroom_nio-1.3.0-py3-none-any.whl
Size 257.2 kB
Tags Python 3
SHA-256 checksum
How to use checksums
4f807ac93044df43c1f38f5312307b2b4c986a9df34286203a6e9ce6103e7b03
BLAKE2b-256 checksum
How to use checksums
bb7761fe7df2242b5aaf71072287e13c1b5dfb090523c800007d6ca2032e0776
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.16

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 31, 2026.

Transparency log

Security for mindroom-nio 1.3.0

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

Full provenance

Both files in this release have been uploaded with provenance metadata.

Select from 2 files

Attestation for mindroom_nio-1.3.0.tar.gz

PyPI Publish Attestation

PyPI verified that this artifact, at this checksum, originated from the publisher listed below.

Signed by GitHub Actions, verified by PyPI on Oct 31, 2026.

Transparency log

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

Release history Release notifications | RSS feed

This release

1.3.0 This release

2 release files Full provenance

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page