Awesome IRC bot
Go to file
Dave Pedu 895804e6c1 Update docs #nobuild 2015-11-29 22:45:37 -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 Add support for multiple server hostnames 2015-11-29 22:42:45 -08:00
pyircbot Add support for multiple server hostnames 2015-11-29 22:42:45 -08:00
.gitignore Add eval/exec to RPC 2015-08-08 15:04:45 -07:00
README.md Update readme 2015-08-30 22:15:41 -07:00
setup.py Convert tabs to spaces 2015-11-01 18:03:11 -08:00

README.md

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

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