dave
/
pyircbot
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
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.
150 Commits
2 Branches
0 Tags
4.3 MiB
Python 99.8%
 
master
dave/xdcc
Branches Tags
${ item.name }
Create tag ${ searchTerm }
Create branch ${ searchTerm }
from '9341153acb'
${ noResults }
Go to file
Dave Pedu 9341153acb Update readme #nobuild 8 years ago
bin Enhance logging 8 years ago
docs Update docs #nobuild 8 years ago
examples Reorganize dockerfile to take advantage of caching 8 years ago
pyircbot Fix ping responder module 8 years ago
.gitignore Add _recv hook 8 years ago
README.md Update readme #nobuild 8 years ago
setup.py Convert tabs to spaces 8 years ago

README.md
Unescape Escape

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

TODO

  • Improve/complete docs
  • Write config checker