Awesome IRC bot
Go to file
dave a73bc9ca00 Add changelog in docs 2017-03-28 17:11:05 -07:00
bin Ditch asynchat for asyncio. Python 2 no longer supported. 2017-03-28 16:25:49 -07:00
docs Add changelog in docs 2017-03-28 17:11:05 -07:00
examples Bump dockerfile base OS version 2017-03-28 16:48:44 -07:00
pyircbot Ditch asynchat for asyncio. Python 2 no longer supported. 2017-03-28 16:25:49 -07: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 Misc & lint fixes 2017-01-01 16:26:54 -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

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