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

Uploaded Source

Built Distribution

matrix_nio-0.18.4-py3-none-any.whl (181.7 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: matrix-nio-0.18.4.tar.gz
  • Upload date:
  • Size: 153.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for matrix-nio-0.18.4.tar.gz
Algorithm Hash digest
SHA256 e5f0a62ff66474f5c56dc40c3eb3c74a29943800589ae6947ea224c288f3ab41
MD5 dfaf1fbfefc7088b4c5d6238793da409
BLAKE2b-256 d03df7b614e0ed1590f95c2fdbf35572ff58ba8bcc336fb33da7f7d214091501

See more details on using hashes here.

Provenance

File details

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

File metadata

  • Download URL: matrix_nio-0.18.4-py3-none-any.whl
  • Upload date:
  • Size: 181.7 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.4.1 importlib_metadata/4.6.0 pkginfo/1.7.1 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.61.2 CPython/3.9.6

File hashes

Hashes for matrix_nio-0.18.4-py3-none-any.whl
Algorithm Hash digest
SHA256 7ea00ae362a3621624b8ff463a2b06cb945ffa12e2f3919cae5321d06285a361
MD5 971a7ee4682b85dc37906fd9698a3a1c
BLAKE2b-256 2837030082ffbff00d818e59a58d97d4fef8c38c8d7d565a47505ac1dc468066

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