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
  • ✅ manual and emoji verification
  • ✅ custom authentication types
  • ✅ well-integrated type system
  • ✅ kick, ban and unban
  • ✅ typing notifications
  • ✅ message redaction
  • ✅ token based login
  • ✅ user registration
  • ✅ read receipts
  • ✅ live syncing
  • m.tags
  • ❌ python 2.7 support
  • ❌ cross-signing support
  • ❌ user deactivation (#112)
  • ❌ in-room emoji verification
  • ❌ room upgrades and m.room.tombstone events (#47)

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.15.2.tar.gz (145.7 kB view details)

Uploaded Source

Built Distribution

matrix_nio-0.15.2-py3-none-any.whl (173.6 kB view details)

Uploaded Python 3

File details

Details for the file matrix-nio-0.15.2.tar.gz.

File metadata

  • Download URL: matrix-nio-0.15.2.tar.gz
  • Upload date:
  • Size: 145.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.8.6 Linux/5.9.1-arch1-1

File hashes

Hashes for matrix-nio-0.15.2.tar.gz
Algorithm Hash digest
SHA256 cc58fae4f47d9dbf14c8f4ddbe7366f58735102464d222d6786c0b691e7834b7
MD5 e60d0ddcbd4447ef2dafcabee08f253a
BLAKE2b-256 79a1a818a09c80070f59702254c1caf4b86ad48b07cf550e14c2d31672b7c4ed

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: matrix_nio-0.15.2-py3-none-any.whl
  • Upload date:
  • Size: 173.6 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: poetry/1.0.10 CPython/3.8.6 Linux/5.9.1-arch1-1

File hashes

Hashes for matrix_nio-0.15.2-py3-none-any.whl
Algorithm Hash digest
SHA256 f7fa4c70fa0f8c578a682975f4aa45d4c48c36ff26b3e1a0cd2877ce32977fb5
MD5 39e35644b084c667c03dce815fb58f03
BLAKE2b-256 9f2595e74d176f23b62e102b8c525c15c25425e6d94862c2b9dd27fa015b6b2d

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