Skip to main content

T O B O T

NAME


tobot - to bot or not to bot !

SYNOPSIS


tobot <cmd> [key=val] [key==val]
tobot -cvaw [init=mod1,mod2]
tobot -d
tobot -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.

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

TOBOT and TOB are Public Domain.

INSTALL

installation is done with pipx


$ pipx install tobot
$ pipx ensurepath

<new terminal>

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

joins #tobot on localhost

USAGE

use tobot to control the program, default it does nothing


$ tobot
$

see list of commands


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

start console


$ tobot -c

start console and run irc and rss clients


$ tobot -c init=irc,rss

list available modules


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

start daemon


$ tobot -d
$

start service


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


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

sasl


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

rss


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

opml


$ tobot exp
$ tobot imp <filename>

PROGRAMMING


tobot has it’s user modules in the ~/.tobot/mods directory so for a
hello world command you would edit a file in ~/.tobot/mods/hello.py
and add the following

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

typing the hello command would result into a nice hello world !!

$ tobot hello
hello world !!

commands run in their own thread and the program borks on exit to enable a
short debug cycle, output gets flushed on print so exceptions appear in the
systemd logs. modules can contain your own written python3 code.

FILES


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

AUTHOR


Bart Thate <bthate@dds.nl>

COPYRIGHT


TOBOT is Public Domain.

Metadata

Release files for tobot 6

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

Source distribution (sdist)

Source distribution for tobot 6
File Size Uploaded Provenance
tobot-6.tar.gz 35.3 kB Without provenance Details

Built distribution (wheel)

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

Total release size: 77.9 kB

Release files / tobot-6.tar.gz

Download URL tobot-6.tar.gz
Size 35.3 kB
Tags Source
SHA-256 checksum
How to use checksums
ae5c8c0f443ca50dc22e5ae3307ccd6e9ee535161a7663a1048cdeb1ec936edc
BLAKE2b-256 checksum
How to use checksums
66fb5e2c4d323ce302f8f47e208259470c3e304acdc6514090843ab5c2e83183
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Release files / tobot-6-py3-none-any.whl

Download URL tobot-6-py3-none-any.whl
Size 42.6 kB
Tags Python 3
SHA-256 checksum
How to use checksums
74819cfb088d5358a5b01337a1ae216d066d215f1e2d6750db1a45d227cf8252
BLAKE2b-256 checksum
How to use checksums
830a1101572a8f83ccfd22665b4e9fee108d9e54b62a9c446905fe0987c4edff
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Security for tobot 6

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