Skip to main content

NAME


tob - TOB

SYNOPSIS


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

DESCRIPTION

TOB 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.

TOB 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.

TOB 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.

TOB is Public Domain.

INSTALL

installation is done with pipx


$ pipx install tob
$ pipx ensurepath

<new terminal>

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

joins #tob on localhost

USAGE

use tob to control the program, default it does nothing


$ tob
$

see list of commands


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

start console


$ tob -c

start console and run irc and rss clients


$ tob -c init=irc,rss

list available modules


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

start daemon


$ tob -d
$

start service


$ tob -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


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

sasl


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

rss


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

opml


$ tob exp
$ tob imp <filename>

PROGRAMMING

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

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

tob uses loading on demand of modules and has a tbl command to generate a table for this.


$ tob tbl > tob/modules/tbl.py

a md5sum can be added to verify the modules md5sums are matching.


$ tob md5

put this value in tob/modules/__init__.py and tob can execute the hello command now.


$ tob hello
hello world !!

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 tob/modules directory for examples.

FILES


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

AUTHOR


Bart Thate <bthate@dds.nl>

COPYRIGHT


TOB is Public Domain.

Metadata

Release files for tob 101

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for tob 101
File Size Uploaded Provenance
tob-101.tar.gz 27.2 kB Without provenance Details

Built distribution (wheel)

Table of built distributions (wheels) for tob 101
File Interpreter ABI Platform
tob-101-py3-none-any.whl Python 3 none any Details

Total release size: 61.6 kB

Release files / tob-101.tar.gz

Download URL tob-101.tar.gz
Size 27.2 kB
Tags Source
SHA-256 checksum
How to use checksums
b84edbb5291fbc3d9579588d9b30ffad43bcd687d3813cb2a4eca8733f783aec
BLAKE2b-256 checksum
How to use checksums
7481165b6f717b5c2be27e5c0a5f113aae7f68ed0c1900124b3449c387dc41a8
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release files / tob-101-py3-none-any.whl

Download URL tob-101-py3-none-any.whl
Size 34.4 kB
Tags Python 3
SHA-256 checksum
How to use checksums
763f810bf20b950d303d4c9bf8ffe488abf441d804567ccd522b4f7ba6f1e4e9
BLAKE2b-256 checksum
How to use checksums
5682d72330e172320e77c2f8ca33a9a7032b9383fa7d4f355d50aa28ec211069
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Security for tob 101

Provenance

Provenance describes where a file came from. On PyPI, provenance is shared via attestations, which provide a verifiable record of the build or publishing details. View details, limitations and caveats.

No provenance found

None of the files in this release were uploaded with provenance metadata.

A note on package security

PyPI is a repository for distributing packages, not a service for auditing them. While third-party security researchers and our staff do their best to detect and remove malicious packages, PyPI cannot guarantee the quality, security or suitability of any given package.

To learn more about protecting yourself from malicious actors, visit our package security documentation.

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