nixt 20

NIXT

NAME

NIXT - you have been nixt

SYNOPSIS

nixt  <cmd> [key=val] [key==val]
nixtc [-a] [-i]
nixtd
nixts

DESCRIPTION

NIXT is python3 code to program objects in a functional way. It
provides a base Object class that has only dunder methods, all
methods are factored out into functions with the objects as the first
argument. It is called Object Programming (OP), OOP without the
oriented.

NIXT allows for easy json save//load to/from disk of objects. 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 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, code to introspect modules for
commands, deferred exception handling to not crash on an error, a
parser to parse commandline options and values, etc.

NIXT has a demo bot, it can connect to IRC, fetch and display RSS
feeds, take todo notes, keep a shopping list and log text. You can
also copy/paste the service file and run it under systemd for 24/7
presence in a IRC channel.

INSTALL

$ pipx install nixt
$ pipx ensurepath

<new terminal>

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

joins #nixt on localhost

USAGE

without any argument the bot does nothing

$ nixt
$

see list of commands

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

start a console

$ nixtc
>

use -i to run init on modules

$ nixtc -i
>

start daemon

$ nixtd
$

start a service

$ nixts

COMMANDS

cfg - irc configuration
cmd - commands
sne - flag a todo item as done
dpl - sets display items
err - show errors
exp - export opml (stdout)
imp - import opml
log - log text
mod - show modules
mre - displays cached output
nme - give rss feed a name
pwd - sasl nickserv name/pass
rem - removes a rss feed
res - restore deleted objects
rss - add a feed
srv - create service file
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 <nsvnick> <nspass>
$ nixt cfg password=<frompwd>

rss

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

opml

$ nixt exp
$ nixt imp <filename>

FILES

~/.nixt
~/.local/bin/nixt
~/.local/bin/nixtc
~/.local/bin/nixtd
~/.local/bin/nixts
~/.local/bin/nixtskl
~/.local/bin/nixtsrv
~/.local/pipx/venvs/nixt/

AUTHOR

Bart Thate <[e-mail]>

COPYRIGHT

NIXT is Public Domain.