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.
214 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 '585efb2c18'
${ noResults }
Go to file
dave 585efb2c18 Add E2E test 6 years ago
bin Add module touch reloading in pubsubbot 6 years ago
docs modernize module system: 5.0.0 6 years ago
examples Add test harness 6 years ago
pyircbot Add E2E test 6 years ago
tests Add E2E test 6 years ago
.gitignore tests 6 years ago
README.md modernize module system: 5.0.0 6 years ago
requirements-test.txt tests 6 years ago
run-example.sh Add test harness 6 years ago
run-tests.sh Add E2E test 6 years ago
setup.py fix unicode error 6 years ago

README.md
Unescape Escape

pyircbot3

A modular python IRC bot

Quick start

  • Install: python3 setup.py install
  • Configure: vim examples/config.json examples/data/config/Services.json
  • Run: pyircbot -c examples/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