Skip to main content

NAME


nixt - NIXT

SYNOPSIS


nixt <cmd> [key=val] [key==val]
nixt -cvaw [init=mod1,mod2]
nixt -d
nixt -s

DESCRIPTION

NIXT has all you need to program a unix cli program, such as disk perisistence for configuration files, event handler to handle the client/server connection, deferred exception handling to not crash on an error, etc.

NIXT contains python3 code to program objects in a functional way. it provides an “clean namespace” Object class that only has dunder methods, so the namespace is not cluttered with method names. This makes storing and reading to/from json possible.

NIXT is a python3 IRC bot, it can connect to IRC, fetch and display RSS feeds, take todo notes, keep a shopping list and log text. You can run it under systemd for 24/7 presence in a IRC channel.

NIXT is Public Domain.

INSTALL

installation is done with pipx


$ pipx install nixt
$ pipx ensurepath

<new terminal>

$ nixt srv > nixt.service
$ sudo mv nixt.service /etc/systemd/system/
$ sudo systemctl enable nixt --now

joins #nixt on localhost

USAGE

use nixt to control the program, default it does nothing


$ nixt
$

see list of commands


$ nixt cmd
cfg,cmd,dne,dpl,err,exp,imp,log,mod,mre,nme,
pwd,rem,req,res,rss,srv,syn,tdo,thr,upt

start console


$ nixt -c

start console and run irc and rss clients


$ nixt -c init=irc,rss

list available modules


$ nixt mod
err,flt,fnd,irc,llm,log,mbx,mdl,mod,req,rss,
rst,slg,tdo,thr,tmr,udp,upt

start daemon


$ nixt -d
$

start service


$ nixt -s
<runs until ctrl-c>

COMMANDS

here is a list of available commands


cfg - irc configuration
cmd - commands
dpl - sets display items
err - show errors
exp - export opml (stdout)
imp - import opml
log - log text
mre - display cached output
pwd - sasl nickserv name/pass
rem - removes a rss feed
res - restore deleted feeds
req - reconsider
rss - add a feed
syn - sync rss feeds
tdo - add todo item
thr - show running threads
upt - show uptime

CONFIGURATION

irc


$ nixt cfg server=<server>
$ nixt cfg channel=<channel>
$ nixt cfg nick=<nick>

sasl


$ nixt pwd <nsnick> <nspass>
$ nixt cfg password=<frompwd>

rss


$ nixt rss <url>
$ nixt dpl <url> <item1,item2>
$ nixt rem <url>
$ nixt nme <url> <name>

opml


$ nixt exp
$ nixt imp <filename>

PROGRAMMING

nixt has it’s modules in the package, so edit a file in nixt/modules/<name>.py and add the following for hello world

def hello(event):
    event.reply("hello world !!")

nixt uses loading on demand of modules and has a tbl command to generate a table.


$ nixt tbl > nixt/modules/tbl.py

nixt can execute the hello command now.


$ nixt hello
hello world !!

Besides creating a table for loading on demand, the tbl command also created md5sum of the available plugins. The md5 command calculates this checksum, you can use this value to check if the modules are what you are thinking they are. Put the checsum in the program in the CHECKSUM variable.

Commands run in their own thread and the program borks on exit, output gets flushed on print so exceptions appear in the systemd logs. Modules can contain your own written python3 code, see the nixt/modules directory for examples.

FILES


~/.nixt
~/.local/bin/nixt
~/.local/pipx/venvs/nixt/*

AUTHOR


Bart Thate <nixtniet@gmail.com>

COPYRIGHT


NIXT is Public Domain.

Download files

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

Source Distribution

nixt-411.tar.gz (34.3 kB view details)

Uploaded Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

nixt-411-py3-none-any.whl (13.1 kB view details)

Uploaded Python 3

File details

Details for the file nixt-411.tar.gz.

File metadata

  • Download URL: nixt-411.tar.gz
  • Upload date:
  • Size: 34.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for nixt-411.tar.gz
Algorithm Hash digest
SHA256 bbf745da9ded52979dd56cec55db4f37ad412066cdd028aaa13b8a3339570b0f
MD5 f43f3dfb0728affb99f34f87beff0781
BLAKE2b-256 598cd0e400a2337592d3c3f1b9760de7582d00e5a3737a89b0eaa8685495e3c4

See more details on using hashes here.

File details

Details for the file nixt-411-py3-none-any.whl.

File metadata

  • Download URL: nixt-411-py3-none-any.whl
  • Upload date:
  • Size: 13.1 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/6.1.0 CPython/3.13.5

File hashes

Hashes for nixt-411-py3-none-any.whl
Algorithm Hash digest
SHA256 e0d8c4bf21cf4740775a19c0d6b92818336a08a8ffa25a705c65adca45be0cbd
MD5 adf7da293604d9693487ef29a51977c9
BLAKE2b-256 fd74198d808c20c156eb72e6aed9548d013c77af82b1ed9e4954fe1fba589c6d

See more details on using hashes here.

Release history Release notifications | RSS feed

452

2 files

451

2 files

450

2 files

440

2 files

433

2 files

432

2 files

431

2 files

430

2 files

421

2 files

420

2 files

413

2 files

412

2 files

This release

411 This release

2 files

410

2 files

400

2 files

390

2 files

381

2 files

380

2 files

370

2 files

362

2 files

361

2 files

360

2 files

350

2 files

340

1 file

331

1 file

330

1 file

323

1 file

322

1 file

321

1 file

320

1 file

310

1 file

301

1 file

300

1 file

230

1 file

222

1 file

221

1 file

220

1 file

212

1 file

211

1 file

210

1 file

201

1 file

200

1 file

172

1 file

171

1 file

170

1 file

161

1 file

160

1 file

150

1 file

140

1 file

130

1 file

121

1 file

120

1 file

110

1 file

100

1 file

92

1 file

91

1 file

90

1 file

71

1 file

70

1 file

62

1 file

61

1 file

60

1 file

57

1 file

56

1 file

55

1 file

54

1 file

53

1 file

52

1 file

51

1 file

50

1 file

42

1 file

40

1 file

31

1 file

30

1 file

20

1 file

18

1 file

17

1 file

16

1 file

15

1 file

14

1 file

13

1 file

12

1 file

11

1 file

10

1 file

7

1 file

6

1 file

5

1 file

4

1 file

3

1 file

2

1 file

1

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page