nixbot

NAME

nixbot - NIXBOT

SYNOPSIS

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

DESCRIPTION

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

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

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

NIXBOT is Public Domain.

INSTALL

installation is done with pipx

$ pipx install nixbot
$ pipx ensurepath

<new terminal>

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

joins #nixbot on localhost

USAGE

use nixbot to control the program, default it does nothing

$ nixbot
$

see list of commands

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

start console

$ nixbot -c

start console and run irc and rss clients

$ nixbot -c init=irc,rss

list available modules

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

start daemon

$ nixbot -d
$

start service

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

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

sasl

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

rss

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

opml

$ nixbot exp
$ nixbot imp <filename>

PROGRAMMING

nixbot has it’s user modules in the ~/.nixbot/mods directory so for a
hello world command you would  edit a file in ~/.nixbot/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 !!

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

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

AUTHOR

Bart Thate <bthate@dds.nl>

COPYRIGHT

NIXBOT is Public Domain.

Development Status
- 3 - Alpha
Operating System
- Unix
Programming Language
- Python :: 3
Topic
- Utilities

Metadata

Development Status
- 3 - Alpha
Operating System
- Unix
Programming Language
- Python :: 3
Topic
- Utilities

Release files for nixbot 180

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

Source distribution (sdist)

Source distribution for nixbot 180
File	Size	Uploaded	Provenance
nixbot-180.tar.gz	38.5 kB	Dec 23, 2025	Without provenance	Details

Built distribution (wheel)

Table of built distributions (wheels) for nixbot 180
File	Interpreter	ABI	Platform	Reset
nixbot-180-py3-none-any.whl 48.9 kB Dec 23, 2025 Without provenance	Python 3	none	any	Details

Total release size: 87.4 kB

Release files / nixbot-180.tar.gz

Download URL	nixbot-180.tar.gz
Size	38.5 kB
Tags	Source
SHA-256 checksum How to use checksums	`3876d803cc94c5c5f7c5298ba535015c6c3a136f79c083a897d9d89bae04868a`
BLAKE2b-256 checksum How to use checksums	`755f8fb203b6e5ab61dd5bd680393c021b4227655030aaeef9aa621da43c3777`
Upload date	Dec 23, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.5`

Release files / nixbot-180-py3-none-any.whl

Download URL	nixbot-180-py3-none-any.whl
Size	48.9 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`97bf8b6580ad6810e9ac7aea10b6c8d6e1b3f1999d268e72946626071d7cceba`
BLAKE2b-256 checksum How to use checksums	`7fe18793d370fd43b47be3340f42d60852a3377b5d6ffb5972439baad4970aa7`
Upload date	Dec 23, 2025
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/6.1.0 CPython/3.13.5`

Security for nixbot 180

Report project as malware

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.