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

Uploaded Source

Built Distribution

matrix_nio-0.18.6-py3-none-any.whl (181.8 kB view details)

Uploaded Python 3

File details

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

File metadata

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

File hashes

Hashes for matrix-nio-0.18.6.tar.gz
Algorithm Hash digest
SHA256 220e604f315d7f77841daf74db160fe35bb871f1b3fd2d2b3ae55bb711b65f72
MD5 12c261f288ceaa7162bcb587ee169eea
BLAKE2b-256 6f9eb01734cb9f5edc1bd7aa0d783721d95b28041e47e8eb3240f2d36f5f2c58

See more details on using hashes here.

Provenance

File details

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

File metadata

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

File hashes

Hashes for matrix_nio-0.18.6-py3-none-any.whl
Algorithm Hash digest
SHA256 0509a6c6066570b0d1a614c7d905f8f0206e344e4724a1fc443eaa54d5707b1a
MD5 6246337d4ed05c61bb0e11ac44d876bd
BLAKE2b-256 622ca1b20d75c3d739c046403fc7c529cd7d15b1f3cab22cab02948e81124e8d

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