Awesome IRC bot
Go to file
2017-12-17 22:43:35 -08:00
bin Solidify & expand pubsub mode communications 2017-12-04 23:58:37 -08:00
docs nick and channel tracking in services module 2017-12-04 23:57:32 -08:00
examples Again with the tests 2017-12-03 23:18:33 -08:00
pyircbot Fix respect matching 2017-12-17 22:43:35 -08:00
tests Again with the tests 2017-12-03 23:18:33 -08:00
.gitignore tests 2017-12-03 00:20:08 -08:00 Update docs with testing info 2017-12-03 21:14:18 -08:00
requirements-test.txt More tests 2017-12-03 20:58:20 -08:00 Add test harness 2017-11-27 19:04:22 -08:00 More tests 2017-12-03 20:58:20 -08:00 fix unicode error 2017-10-12 23:35:42 -07:00


A modular python IRC bot

Quick start

  • Install: python3 install
  • Configure: vim examples/config.json examples/data/config/Services.json
  • Run: pyircbot -c examples/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


PyIRCBot has great test coverage. After installing the contents of requirements-test.txt, the script ./ will run all tests. See the contents of the script for more information. See in ./tests/ for more info.


  • Improve/complete docs
  • Write config checker