dave
/
pyircbot
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Awesome IRC bot
103 Commits 2 Branches 0 Tags 4.3 MiB
Python 99.8%
Go to file
dpedu 9cb4800dc8 Fix hardcoded name 2015-08-11 15:24:25 -07:00
bin Allow json for native module configs 2015-06-18 20:43:17 -07:00
docs Update docs 2015-08-11 15:24:02 -07:00
examples Add simplified style hook arguments 2015-08-08 22:50:04 -07:00
pyircbot Fix hardcoded name 2015-08-11 15:24:25 -07:00
.gitignore Add eval/exec to RPC 2015-08-08 15:04:45 -07:00
README.md Update readmes 2015-06-19 21:09:43 -07:00
setup.py Module installer should include the submodules 2015-06-18 22:28:26 -07: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

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 Developer’s Guide in the docs

TODO

  • Improve/complete docs
  • Add a way to pass additional directories where modules are stored