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

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

TOBOT 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 is 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 8

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 8
File Size Uploaded Provenance
tobot-8.tar.gz 36.4 kB Without provenance Details

Built distribution (wheel)

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

Total release size: 82.4 kB

Release files / tobot-8.tar.gz

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

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

Download URL tobot-8-py3-none-any.whl
Size 46.0 kB
Tags Python 3
SHA-256 checksum
How to use checksums
9d2348ddecc40818cd9cfe6b72a64d30a682b49b9e462011523cfc8297a1087e
BLAKE2b-256 checksum
How to use checksums
fa5358dff4034699a237ecc4c99b59926600c56dab27f07b5cdfdd0aa48c147a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Security for tobot 8

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