Awesome IRC bot
You can not 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 Pedu 12ed393f6c
Prevent crash when bot calls _connect and fails due to dns lookup failure
7 years ago
bin Enhance logging 7 years ago
docs Update docs #nobuild 7 years ago
examples Fix dockerfile, supervisor con for the bot was missing 7 years ago
pyircbot Prevent crash when bot calls _connect and fails due to dns lookup failure 7 years ago
.gitignore Add _recv hook 7 years ago
README.md Update readme #nobuild 7 years ago
setup.py Convert tabs to spaces 7 years ago

README.md

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

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