objd 3

object daemon

NAME

OBJD - object daemon

SYNOPSIS

objd <cmd> [key=val] [key==val]
objd [-a] [-c] [-d] [-h] [-v] [-w]

options are:

-a     load all modules
-c     start console
-d     start daemon
-h     display help
-v     use verbose

DESCRIPTION

OBJD 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 also
copy/paste the service file and run it under systemd for 24/7 presence
in a IRC channel.

OBJD users OBJR, containing 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.

OBJD uses OBJX, an module 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.

OBJD is Public Domain.

USAGE

without any argument the program starts a daemon

$ objd
$

with arguments the bot will run it as a command, use `cmd` to see list
of commands

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

list of modules

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

use -c to start a console

$ objd -c

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

$ objd -c mod=irc,rss
>

use -v for verbose

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

CONFIGURATION

$ objd cfg
channel=#zbot commands=True nick=zbot port=6667 server=localhost

irc

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

sasl

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

rss

$ objd rss <url>
$ objd dpl <url> <item1,item2>
$ objd rem <url>
$ objd 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
rss - add a feed
thr - show the running threads

SYSTEMD

save the following it in /etc/systems/system/objd.service and
replace "<user>" with the user running pipx

[Unit]
Description=object daemon
Requires=network-online.target
After=network-online.target

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

[Install]
WantedBy=default.target

then run this

$ pipx ensurepath
$ mkdir ~/.objd
$ sudo systemctl enable objd --now

default channel/server is #objd on localhost

FILES

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

AUTHOR

Bart Thate <[e-mail]>

COPYRIGHT

OBJD is Public Domain.