Awesome IRC bot
Go to file
dave c2e2199b02 Merge branch 'master' into 'master'
Text CDC

See merge request !1
2015-08-08 12:33:49 -07:00
bin Allow json for native module configs 2015-06-18 20:43:17 -07:00
docs Clarify config docs 2015-07-18 21:45:29 -07:00
examples Add generic config 2015-08-08 15:19:12 -04:00
pyircbot Add TextCDC 2015-08-08 15:05:32 -04:00
.gitignore Make doc builder a little more useful 2015-07-18 21:10:39 -07:00
README.md Update readmes 2015-06-19 21:09:43 -07:00
setup.py Module installer should include the submodules 2015-06-18 22:28:26 -07: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

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
  • Add a way to pass additional directories where modules are stored