Skip to main content

Command line instant messenger inspired by centericq/centerim

Project description

nuqql

nuqql is a command line instant messenger inspired by centericq and centerim written in Python and using ncurses.

nuqql uses so-called backends for connecting to chat networks. Currently, nuqql supports nuqql-slixmppd, nuqql-matrixd, and purpled as backends. nuqql-slixmppd uses slixmpp and allows nuqql to connect to XMPP chat networks. nuqql-matrixd uses the Matrix Python SDK and allows nuqql to connect to Matrix chat networks. purpled uses libpurple and allows nuqql to connect to multiple chat networks.

Quick Start

You can install nuqql, for example, with pip for your user only with the following command:

$ pip install --user nuqql

The basic nuqql setup consist of installing one or more backends and adding your instant messaging accounts to them. See setup for more information about how to setup nuqql.

Run

After the installation, you can run nuqql with the nuqql command:

$ nuqql

Overview

The layout of nuqql is as follows:

+--------------+----------------+
|              |                |
|              |                |
|              |                |
|              |   Log Window   |
|              |                |
| List Window  |                |
|              |                |
|              +----------------+
|              |                |
|              |  Input Window  |
|              |                |
+--------------+----------------+
  • List Window: shows the Conversation List
  • Log Window: shows the Log of the current Conversation
  • Input Window: shows the user's input of the current Conversation

The Conversation List shows your buddies and special conversations for your backend commands and nuqql commands. Buddies are shown with their status (on, afk, off) and their name, e.g., [on] buddy@jabber.org. Group chats and invites to group chats are shown with [grp] and [grp_invite] as a special status. The nuqql and backend command conversations are shown as {nuqql} and with {backend} in front of their name, e.g., {backend} slixmppd.

Controls

Basic controls of nuqql are:

  • Navigate the Conversation List with the arrow keys UP and DOWN
  • Press ENTER on a conversation to open it
  • Press h on a conversation to open it and switch to its chat log
  • In a conversation:
    • Enter your message/command
    • Send message/command with CTRL-x
    • Switch to chat log window with CTRL-o
      • Search chat log with /
      • Zoom chat log with F9
    • Leave conversation with the ESC key
  • Exit nuqql with the q key when you are in no conversation

See controls for more information about nuqql's controls.

Development

Most of the development happens in the devel branch. When a new version of nuqql is released, the devel code is merged into the master branch. So, if you want to try the latest code, check out the devel branch, otherwise just use master.

Changes

See changelog for changes in each version.

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

nuqql-0.8.tar.gz (37.4 kB view details)

Uploaded Source

Built Distribution

nuqql-0.8-py3-none-any.whl (41.9 kB view details)

Uploaded Python 3

File details

Details for the file nuqql-0.8.tar.gz.

File metadata

  • Download URL: nuqql-0.8.tar.gz
  • Upload date:
  • Size: 37.4 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.8.0

File hashes

Hashes for nuqql-0.8.tar.gz
Algorithm Hash digest
SHA256 e9187b2c3ec3cc01f3b58b92a1515dfd6bf5ab2756ce5c847d4c9b1a3d4a8427
MD5 88f17de92ca4de668c5155dd2275a4a6
BLAKE2b-256 81660bbaa8512eb9fd631fee0020f21d0420723ae77151584889c66335e5bc0d

See more details on using hashes here.

Provenance

File details

Details for the file nuqql-0.8-py3-none-any.whl.

File metadata

  • Download URL: nuqql-0.8-py3-none-any.whl
  • Upload date:
  • Size: 41.9 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/3.1.1 pkginfo/1.5.0.1 requests/2.22.0 setuptools/41.6.0 requests-toolbelt/0.9.1 tqdm/4.40.2 CPython/3.8.0

File hashes

Hashes for nuqql-0.8-py3-none-any.whl
Algorithm Hash digest
SHA256 43cfd6f4cfef2916672af1e932e6a98ab8b622ff0f2282d036bcb2e1edcd15ff
MD5 8a530669298b19326a6e214d67aed972
BLAKE2b-256 3a449c186e879d45e5fb9293a472665c1d138ea66af3d362571979febe28af58

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