Matrix client network daemon using matrix-nio
Project description
nuqql-matrixd-nio
nuqql-matrixd-nio is a network daemon that implements the nuqql interface and uses matrix-nio to connect to Matrix chat networks. It can be used as a backend for nuqql or as a standalone chat client daemon.
nuqql-matrixd-nio's dependencies are:
- nuqql-based
- matrix-nio with enabled end-to-end encryption which needs libolm (version 3.x)
- daemon (optional)
Quick Start
Make sure you have libolm installed.
You can install nuqql-matrixd-nio and its other dependencies, for example, with pip for your user only with the following command:
$ pip install --user nuqql-matrixd-nio
After the installation, you can run nuqql-matrixd-nio by running the
nuqql-matrixd-nio
command:
$ nuqql-matrixd-nio
By default, it listens on TCP port 32000 on your local host. So, you can connect with, e.g., telnet to it with the following command:
$ telnet localhost 32000
In the telnet session you can:
- add Matrix accounts with:
account add matrix <account> <password>
.- Note: the format of
<account>
is<username>@<homeserver>
, e.g.,dummy_user@matrix.org
.
- Note: the format of
- retrieve the list of accounts and their numbers/IDs with
account list
. - retrieve your buddy/room list with
account <id> buddies
oraccount <id> chat list
- send a message to a room with
account <id> chat send <room> <message>
- get a list of commands with
help
Usage
See nuqql-matrixd-nio --help
for a list of command line arguments:
usage: nuqql-matrixd-nio [-h] [--version] [--af {inet,unix}] [--address
ADDRESS] [--port PORT] [--sockfile SOCKFILE] [--dir DIR] [-d] [--loglevel
{debug,info,warn,error}] [--disable-history] [--push-accounts]
Run nuqql backend.
optional arguments:
-h, --help show this help message and exit
--version show program's version number and exit
--af {inet,unix} socket address family: "inet" for AF_INET, "unix" for
AF_UNIX
--address ADDRESS AF_INET listen address
--port PORT AF_INET listen port
--sockfile SOCKFILE AF_UNIX socket file in DIR
--dir DIR working directory
-d, --daemonize daemonize process
--loglevel {debug,info,warn,error}
Logging level
--disable-history disable message history
--push-accounts push accounts to client
Changes
- v0.1.0:
- First/initial release.
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
Built Distribution
Hashes for nuqql_matrixd_nio-0.1.0-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | c0f764b21eb12d704f4c09813a1cab3919eeb6d57ea3c261231b6bd84181591f |
|
MD5 | 98f22e5a4dcfda21c50814bf9d25e022 |
|
BLAKE2b-256 | 4ab282a3388b5d30334dc314484aa11b45ec8f9e7999b59076e66d8f1301a396 |