Skip to main content

NAME


nixbot - NIXBOT

SYNOPSIS


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

DESCRIPTION

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

NIXT 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 modules in the package, so edit a file in nixbot/modules/<name>.py and add the following for hello world

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

include the <name> in nixbot/modules/__init__.py and nixbot can execute the hello command now.


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

FILES


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

AUTHOR


Bart Thate <nixtniet@gmail.com>

COPYRIGHT


NIXBOT is Public Domain.

Metadata

Release files for nixbot 120

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 120
File Size Uploaded Provenance
nixbot-120.tar.gz 34.0 kB Without provenance Details

Built distribution (wheel)

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

Total release size: 76.8 kB

Release files / nixbot-120.tar.gz

Download URL nixbot-120.tar.gz
Size 34.0 kB
Tags Source
SHA-256 checksum
How to use checksums
a1994550be2f19afe55f94faee66a21f27f5883ed02b34e1bfd68b6ae5d47494
BLAKE2b-256 checksum
How to use checksums
ac98fb1bf3fc59cb21addbe2f5f4eabd9f80c6a1072524980623c8b0974036f6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

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

Download URL nixbot-120-py3-none-any.whl
Size 42.8 kB
Tags Python 3
SHA-256 checksum
How to use checksums
59dbf7e8a9d4927cd64861588a33aca188585cdee345045681799c290c1985f5
BLAKE2b-256 checksum
How to use checksums
4bbd596d08cee12c95cb5260fd4fd96d98384c9a2db53adcdc1a254ebbceaa9e
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
No
Uploaded via twine/6.1.0 CPython/3.13.5

Security for nixbot 120

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