objx 31

objects

NAME

OBJX - objects

INSTALL

$ pipx install objx

SYNOPSIS

objx <cmd> [key=val]
objx <cmd> [key==val]
objx [-a] [-c] [-d] [-v]

DESCRIPTION

OBJX has all the python3 code 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.

OBJX provides an objx namespace that 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.

OBJX provides 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.

OBJX is Public Domain.

USAGE

without any argument the program does nothing

$ objx
$

see list of commands

$ objx cmd
cmd,err,mod,req,thr,ver

list of modules

$ objx mod
cmd,err,fnd,irc,log,mod,req,rss,tdo,thr

use mod=<name1,name2> to load additional modules

$ objx cfg mod=irc

start a console

$ objx -c mod=irc,rss
>

use -v for verbose

$ objx -cv mod=irc
OBJX started CV started Sat Dec 2 17:53:24 2023
>

start daemon

$ objd
$

CONFIGURATION

irc

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

sasl

$ objx pwd <nsvnick> <nspass>
$ objx cfg password=<frompwd>

rss

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

COMMANDS

cmd - commands
cfg - irc configuration
dlt - remove a user
dpl - sets display items
fnd - find objects
log - log some text
met - add a user
mre - displays cached output
pwd - sasl nickserv name/pass
rem - removes a rss feed
req - reconsider
rss - add a feed
thr - show the running threads

SYSTEMD

save the following it in /etc/systems/system/objx.service and replace “<user>” with the user running pipx

[Unit]
Description=objects daemon
Requires=network.target
After=network.target

[Service]
Type=simple
User=<user>
Group=<user>
WorkingDirectory=/home/<user>/.objx
ExecStart=/home/<user>/.local/pipx/venvs/objx/bin/objd
RemainAfterExit=yes

[Install]
WantedBy=multi-user.target

then run this

$ mkdir ~/.objx
$ sudo systemctl enable objx --now

default channel/server is #objx on localhost

CODE

>>> from objx import Object, read, write
>>> o = Object()
>>> o.a = "b"
>>> write(o, "test")
>>> oo = Object()
>>> read(oo, "test")
>>> oo
{"a": "b"}

FILES

~/.objx
~/.local/bin/objx
~/.local/bin/objd
~/.local/pipx/venvs/objx/

AUTHOR

Bart Thate <[e-mail]>

COPYRIGHT

OBJX is Public Domain.