Awesome IRC bot
Go to file
dave 2d463d9b99 another uno fix 2017-10-15 22:13:24 -07:00
bin Support reading config from stdin 2017-05-01 08:29:20 -07:00
docs Add docs and update dockerfiles 2017-09-21 21:09:35 -07:00
examples Add docs and update dockerfiles 2017-09-21 21:09:35 -07:00
pyircbot another uno fix 2017-10-15 22:13:24 -07:00
.gitignore Add _recv hook 2015-12-13 13:40:44 -08:00 Update readme #nobuild 2015-12-13 14:17:15 -08:00 fix unicode error 2017-10-12 23:35:42 -07:00


A modular python IRC bot

Quick start

  • Install: python3 install
  • Configure: cd examples ; vim config.json data/config/Services.json
  • Run: pyircbot -c config.json

Running in docker

A dockerfile is included at examples/docker/. From the root of this repository, run docker build -t pyircbot -f examples/docker/Dockerfile . to build it. Typical use is mounting a directory from the host onto /srv/bot; this dir should contain config.json and any other dirs it references.

Building Docs

  • Install sphinx and all modules pyircbot depends on
  • cd docs ; make html
  • Open _build/index.html

Or, use my pre-built copy here.

Alternatively, use the included Dockerfile to create an environment for building the docs. Check docs/builder/

Developing Modules

Check Module Developers Guide in the docs


  • Improve/complete docs
  • Write config checker