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.
dpedu 789dfc96c5
Use private map for asynchat
8 years ago
bin Allow json for native module configs 8 years ago
docs Update readmes 8 years ago
examples Change example config to so simpleyaml isn't required 8 years ago
pyircbot Use private map for asynchat 8 years ago
.gitignore Remove core config 8 years ago
README.md Update readmes 8 years ago
setup.py Module installer should include the submodules 8 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

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