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 c2e2199b02
Merge branch 'master' into 'master'
8 years ago
bin Allow json for native module configs 8 years ago
docs Clarify config docs 8 years ago
examples Add generic config 8 years ago
pyircbot Add TextCDC 8 years ago
.gitignore Make doc builder a little more useful 8 years ago
README.md Update readmes 8 years ago
setup.py Module installer should include the submodules 8 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

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