Skip to main content

you have been nixt

Project description

NAME

NIXT - you have been nixt

SYNOPSIS

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

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>

$ nixt srv > 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
$

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/pipx/venvs/nixt/

AUTHOR

Bart Thate <rssbotd@gmail.com>

COPYRIGHT

NIXT is Public Domain.

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

nixt-18.tar.gz (37.7 kB view details)

Uploaded Source

File details

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

File metadata

  • Download URL: nixt-18.tar.gz
  • Upload date:
  • Size: 37.7 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/4.0.2 CPython/3.11.2

File hashes

Hashes for nixt-18.tar.gz
Algorithm Hash digest
SHA256 e46e0e2bd4325a97d9210bd94a07d2852123210406527c020a163bf2874fd58c
MD5 69f676598f68c039bc14a6ff56735502
BLAKE2b-256 dda0ed688476482f0fd296b53d70af3a4f0dc7d66ef1843d169601c3d9b26012

See more details on using hashes here.

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