| Name | matrix-nio JSON |
| Version |
0.25.2
JSON |
| download |
| home_page | None |
| Summary | A Python Matrix client library, designed according to sans I/O principles. |
| upload_time | 2024-10-04 07:51:41 |
| maintainer | None |
| docs_url | None |
| author | None |
| requires_python | >=3.8.0 |
| license | Internet Systems Consortium license =================================== Copyright (c) `2018`, `Damir Jelić <poljar@termina.org.uk>` Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED "AS IS" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. |
| keywords |
|
| VCS |
 |
| bugtrack_url |
|
| requirements |
No requirements were recorded.
|
| Travis-CI |
No Travis.
|
| coveralls test coverage |
No coveralls.
|
nio
===
[](https://github.com/matrix-nio/matrix-nio/actions)
[](https://pypi.org/project/matrix-nio/)
[](https://codecov.io/gh/matrix-nio/matrix-nio)
[](https://github.com/matrix-nio/matrix-nio/blob/master/LICENSE.md)
[](https://matrix-nio.readthedocs.io/en/latest/?badge=latest)
[](https://matrix.to/#/!JiiOHXrIUCtcOJsZCa:matrix.org?via=matrix.org&via=maunium.net&via=t2l.io)
nio is a multilayered [Matrix](https://matrix.org/) 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](https://github.com/aio-libs/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](https://matrix-nio.readthedocs.io/en/latest/#api-documentation)
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](https://matrix.org/docs/spec/client_server/r0.6.0#id183)
- ✅ 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.reaction`s
- ✅ `m.tag`s
- ❌ cross-signing support
- ❌ server-side key backups (room key backup, "Secure Backup")
- ❌ user deactivation ([#112](https://github.com/matrix-nio/matrix-nio/issues/112))
- ❌ in-room emoji verification
Installation
------------
To install nio, simply use pip:
```bash
$ 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](https://gitlab.matrix.org/matrix-org/olm) 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](https://brew.sh/) 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:
```bash
$ 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](https://matrix-nio.readthedocs.io/en/latest/examples.html)
Raw data
{
"_id": null,
"home_page": null,
"name": "matrix-nio",
"maintainer": null,
"docs_url": null,
"requires_python": ">=3.8.0",
"maintainer_email": null,
"keywords": null,
"author": null,
"author_email": "Damir Jeli\u0107 <poljar@termina.org.uk>, Paarth Shah <mail@shahpaarth.com>",
"download_url": "https://files.pythonhosted.org/packages/33/50/c20129fd6f0e1aad3510feefd3229427fc8163a111f3911ed834e414116b/matrix_nio-0.25.2.tar.gz",
"platform": null,
"description": "nio\n===\n\n[](https://github.com/matrix-nio/matrix-nio/actions)\n[](https://pypi.org/project/matrix-nio/)\n[](https://codecov.io/gh/matrix-nio/matrix-nio)\n[](https://github.com/matrix-nio/matrix-nio/blob/master/LICENSE.md)\n[](https://matrix-nio.readthedocs.io/en/latest/?badge=latest)\n[](https://matrix.to/#/!JiiOHXrIUCtcOJsZCa:matrix.org?via=matrix.org&via=maunium.net&via=t2l.io)\n\nnio is a multilayered [Matrix](https://matrix.org/) client library. The\nunderlying base layer doesn't do any network IO on its own, but on top of that\nis a full-fledged batteries-included asyncio layer using\n[aiohttp](https://github.com/aio-libs/aiohttp/). File IO is only done if you\nenable end-to-end encryption (E2EE).\n\nDocumentation\n-------------\n\nThe full API documentation for nio can be found at\n[https://matrix-nio.readthedocs.io](https://matrix-nio.readthedocs.io/en/latest/#api-documentation)\n\nFeatures\n--------\n\nnio has most of the features you'd expect in a Matrix library, but it's still a work in progress.\n\n- \u2705 transparent end-to-end encryption (EE2E)\n- \u2705 encrypted file uploads & downloads\n- \u2705 space parents/children\n- \u2705 manual and emoji verification\n- \u2705 custom [authentication types](https://matrix.org/docs/spec/client_server/r0.6.0#id183)\n- \u2705 threading support\n- \u2705 well-integrated type system\n- \u2705 knocking, kick, ban and unban\n- \u2705 typing notifications\n- \u2705 message redaction\n- \u2705 token based login\n- \u2705 user registration\n- \u2705 read receipts\n- \u2705 live syncing\n- \u2705 `m.reaction`s\n- \u2705 `m.tag`s\n- \u274c cross-signing support\n- \u274c server-side key backups (room key backup, \"Secure Backup\")\n- \u274c user deactivation ([#112](https://github.com/matrix-nio/matrix-nio/issues/112))\n- \u274c in-room emoji verification\n\nInstallation\n------------\n\nTo install nio, simply use pip:\n\n```bash\n$ pip install matrix-nio\n```\n\nNote that this installs nio without end-to-end encryption support. For e2ee\nsupport, python-olm is needed which requires the\n[libolm](https://gitlab.matrix.org/matrix-org/olm) C library (version 3.x).\nOn Debian and Ubuntu one can use `apt-get` to install package `libolm-dev`.\nOn Fedora one can use `dnf` to install package `libolm-devel`.\nOn MacOS one can use [brew](https://brew.sh/) to install package `libolm`.\nMake sure version 3 is installed.\n\nAfter libolm has been installed, the e2ee enabled version of nio can be\ninstalled using pip:\n\n```bash\n$ pip install matrix-nio[e2e]\n```\n\nAdditionally, a docker image with the e2ee enabled version of nio is provided in\nthe `docker/` directory.\n\nExamples\n--------\n\nFor examples of how to use nio, and how others are using it,\n[read the docs](https://matrix-nio.readthedocs.io/en/latest/examples.html)\n",
"bugtrack_url": null,
"license": "Internet Systems Consortium license =================================== Copyright (c) `2018`, `Damir Jeli\u0107 <poljar@termina.org.uk>` Permission to use, copy, modify, and/or distribute this software for any purpose with or without fee is hereby granted, provided that the above copyright notice and this permission notice appear in all copies. THE SOFTWARE IS PROVIDED \"AS IS\" AND THE AUTHOR DISCLAIMS ALL WARRANTIES WITH REGARD TO THIS SOFTWARE INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS. IN NO EVENT SHALL THE AUTHOR BE LIABLE FOR ANY SPECIAL, DIRECT, INDIRECT, OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RESULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH THE USE OR PERFORMANCE OF THIS SOFTWARE. ",
"summary": "A Python Matrix client library, designed according to sans I/O principles.",
"version": "0.25.2",
"project_urls": {
"Documentation": "https://matrix-nio.readthedocs.io/en/latest/",
"Source": "https://github.com/matrix-nio/matrix-nio"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "7b0f8b958d46e23ed4f69d2cffd63b46bb097a1155524e2e7f5c4279c8691c4a",
"md5": "b02cb7a4e03074dd9f947dbfd0a54129",
"sha256": "9c2880004b0e475db874456c0f79b7dd2b6285073a7663bcaca29e0754a67495"
},
"downloads": -1,
"filename": "matrix_nio-0.25.2-py3-none-any.whl",
"has_sig": false,
"md5_digest": "b02cb7a4e03074dd9f947dbfd0a54129",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": ">=3.8.0",
"size": 181982,
"upload_time": "2024-10-04T07:51:39",
"upload_time_iso_8601": "2024-10-04T07:51:39.451174Z",
"url": "https://files.pythonhosted.org/packages/7b/0f/8b958d46e23ed4f69d2cffd63b46bb097a1155524e2e7f5c4279c8691c4a/matrix_nio-0.25.2-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "3350c20129fd6f0e1aad3510feefd3229427fc8163a111f3911ed834e414116b",
"md5": "2834300e437134a90126fd3be5690238",
"sha256": "8ef8180c374e12368e5c83a692abfb3bab8d71efcd17c5560b5c40c9b6f2f600"
},
"downloads": -1,
"filename": "matrix_nio-0.25.2.tar.gz",
"has_sig": false,
"md5_digest": "2834300e437134a90126fd3be5690238",
"packagetype": "sdist",
"python_version": "source",
"requires_python": ">=3.8.0",
"size": 155480,
"upload_time": "2024-10-04T07:51:41",
"upload_time_iso_8601": "2024-10-04T07:51:41.620993Z",
"url": "https://files.pythonhosted.org/packages/33/50/c20129fd6f0e1aad3510feefd3229427fc8163a111f3911ed834e414116b/matrix_nio-0.25.2.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-04 07:51:41",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "matrix-nio",
"github_project": "matrix-nio",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"tox": true,
"lcname": "matrix-nio"
}
