Awesome IRC bot
Go to file
dpedu 2e25a7ed04 Make sys exit optional 2015-08-30 23:23:09 -07:00
bin Allow json for native module configs 2015-06-18 20:43:17 -07:00
docs Update docs 2015-08-11 22:13:13 -07:00
examples Fix dockerfile 2015-08-30 23:22:54 -07:00
pyircbot Make sys exit optional 2015-08-30 23:23:09 -07: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 Module installer should include the submodules 2015-06-18 22:28:26 -07: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