Skip to main content

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

Project description

nio

Build Status 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
  • ✅ well-integrated type system
  • ✅ knocking, kick, ban and unban
  • ✅ typing notifications
  • ✅ message redaction
  • ✅ token based login
  • ✅ user registration
  • ✅ read receipts
  • ✅ live syncing
  • m.tags
  • ❌ cross-signing support
  • ❌ server-side key backups (room key backup, "Secure Backup")
  • ❌ user deactivation (#112)
  • ❌ threading support
  • ❌ 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.21.0.tar.gz (146.6 kB view details)

Uploaded Source

Built Distribution

matrix_nio-0.21.0-py3-none-any.whl (173.5 kB view details)

Uploaded Python 3

File details

Details for the file matrix_nio-0.21.0.tar.gz.

File metadata

  • Download URL: matrix_nio-0.21.0.tar.gz
  • Upload date:
  • Size: 146.6 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for matrix_nio-0.21.0.tar.gz
Algorithm Hash digest
SHA256 d08ae9c3e4021db246b28f2c58bca4d451f665a02c5390552e493213ac989f62
MD5 9470dc5f5552dca93cfb099eeafd75be
BLAKE2b-256 3af85a13d75dd9b6ec0ca7ccce9151b9357abf27c2b8ccd327672fbba550a424

See more details on using hashes here.

Provenance

File details

Details for the file matrix_nio-0.21.0-py3-none-any.whl.

File metadata

  • Download URL: matrix_nio-0.21.0-py3-none-any.whl
  • Upload date:
  • Size: 173.5 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.4

File hashes

Hashes for matrix_nio-0.21.0-py3-none-any.whl
Algorithm Hash digest
SHA256 4ba363c70a5e04fb87e036ca82c2fc606cea744d216249c469b2386c6d07817f
MD5 9436d0ddf152d117a7316a4f9471d543
BLAKE2b-256 c68e9c966c83e3cf94dd51f5dc7a207f29635f20104ad2ab29f6cf05ff704801

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