Skip to main content

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

Project description

nio

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

nio is a multilayered Matrix client library. 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 nio, simply use pip:

$ pip install matrix-nio

Note that this installs nio without end-to-end encryption support. For e2ee support, python-olm is needed which requires the libolm C library (version 3.x). On Debian and Ubuntu one can use apt-get to install package libolm-dev. On Fedora one can use dnf to install package libolm-devel. On MacOS one can use brew to install package libolm. Make sure version 3 is installed.

After libolm has been installed, the e2ee enabled version of nio can be installed using pip:

$ pip install matrix-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

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

matrix_nio-0.25.0rc2.tar.gz (152.6 kB view details)

Uploaded Source

Built Distribution

matrix_nio-0.25.0rc2-py3-none-any.whl (178.9 kB view details)

Uploaded Python 3

File details

Details for the file matrix_nio-0.25.0rc2.tar.gz.

File metadata

  • Download URL: matrix_nio-0.25.0rc2.tar.gz
  • Upload date:
  • Size: 152.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? Yes
  • Uploaded via: twine/5.0.0 CPython/3.12.3

File hashes

Hashes for matrix_nio-0.25.0rc2.tar.gz
Algorithm Hash digest
SHA256 38c130459762ee5fab7a68d76dda336c59a82d0a8a3b9440f485c76ff0728473
MD5 732ba04d19b7633ad8ffc3375286e512
BLAKE2b-256 9d7483951e4a8e3193c1b93d84abbc8ec675c4059d2190754ec2d0cb954e1909

See more details on using hashes here.

Provenance

File details

Details for the file matrix_nio-0.25.0rc2-py3-none-any.whl.

File metadata

File hashes

Hashes for matrix_nio-0.25.0rc2-py3-none-any.whl
Algorithm Hash digest
SHA256 462b041c3ae01e57a7c0145ee362796a72324f298e86717403e78d5024413c00
MD5 9354dc4e3e4ba9fd44b983b2486c85ac
BLAKE2b-256 5d63aff2543bcfc84af0a453dd3b91df4d4874cbeba2f6460318f1ac88635aea

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page