Awesome IRC bot
Go to file
2015-12-13 14:17:15 -08:00
bin Enhance logging 2015-11-27 02:16:04 -08:00
docs Update docs #nobuild 2015-11-29 22:45:37 -08:00
examples Reorganize dockerfile to take advantage of caching 2015-12-13 14:12:21 -08:00
pyircbot Fix ping responder module 2015-12-13 13:40:53 -08:00
.gitignore Add _recv hook 2015-12-13 13:40:44 -08:00
README.md Update readme #nobuild 2015-12-13 14:17:15 -08:00
setup.py Convert tabs to spaces 2015-11-01 18:03:11 -08:00

pyircbot3

A modular python IRC bot

Quick start

  • Install: python3 setup.py 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/README.md.

Developing Modules

Check Module Developers Guide in the docs

TODO

  • Improve/complete docs
  • Write config checker