Skip to main content

Matrix client network daemon using the Matrix Python SDK

Project description

nuqql-matrixd

nuqql-matrixd is a network daemon that implements the nuqql interface and uses the Matrix Python SDK to connect to Matrix chat networks. It can be used as a backend for nuqql or as a standalone chat client daemon.

nuqql-matrixd's dependencies are:

Quick Start

You can install nuqql-matrixd and its dependencies, for example, with pip for your user only with the following command:

$ pip install --user nuqql-matrixd

After the installation, you can run nuqql-matrixd by running the nuqql-matrixd command:

$ nuqql-matrixd

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.
  • retrieve the list of accounts and their numbers/IDs with account list.
  • retrieve your buddy/room list with account <id> buddies or account <id> chat list
  • send a message to a room with account <id> chat send <room> <message>

Usage

See nuqql-matrixd --help for a list of command line arguments:

usage: nuqql-matrixd [-h] [--version] [--af {inet,unix}] [--address ADDRESS]
[--port PORT] [--sockfile SOCKFILE] [--dir DIR] [-d] [--loglevel
{debug,info,warn,error}] [--disable-history]

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

Changes

  • v0.3:
    • Use nuqql-based as dependency and adapt to nuqql-based changes
    • Add setup.py for installation and package distribution
    • Add python type annotations
    • Restructure code
    • Cleanups, fixes, and improvements
  • v0.2:
    • Allow specification of the homeserver url in the account user when adding an account. Thus, the following account users are possible:
      • <user>@<domain> (defaults to https)
      • <user>@http://<domain>[:<port>]
      • <user>@https://<domain>[:<port>]
    • Save sync token for each account in a file. So, only messages newer than the last sync are retrieved after a restart of the backend.
    • Add new commands:
      • bye: disconnect from the backend.
      • quit: quit the backend.
      • help: show list of commands and their description.
    • Add and use "chat msg" message format for group chat messages
    • Store accounts in .ini file accounts.ini in the backend's working directory. Note: existing accounts have to be re-added to the backend to be usable with the .ini file.
    • Add configuration file support: in addition to the command line arguments, configuration parameters can now be set in the .ini file config.ini in the backend's working directory.
    • Add loglevel configuration parameter to command line arguments and configuration file for setting the logging level to debug, info, warn, or error. Default: warn.
    • Make daemon python module optional
    • Fixes and improvements
  • v0.1:
    • First/initial release.

Project details


Release history Release notifications

This version

0.3

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Files for nuqql-matrixd, version 0.3
Filename, size File type Python version Upload date Hashes
Filename, size nuqql_matrixd-0.3-py3-none-any.whl (13.2 kB) File type Wheel Python version py3 Upload date Hashes View hashes
Filename, size nuqql-matrixd-0.3.tar.gz (13.0 kB) File type Source Python version None Upload date Hashes View hashes

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN DigiCert DigiCert EV certificate StatusPage StatusPage Status page