Awesome IRC bot
You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
dave 2d463d9b99 another uno fix 6 years ago
bin Support reading config from stdin 6 years ago
docs Add docs and update dockerfiles 6 years ago
examples Add docs and update dockerfiles 6 years ago
pyircbot another uno fix 6 years ago
.gitignore Add _recv hook 8 years ago
README.md Update readme #nobuild 8 years ago
setup.py fix unicode error 6 years ago

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