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 4e9ae35e6c Update docs with testing info 4 years ago
bin Add module touch reloading in pubsubbot 4 years ago
docs Update docs with testing info 4 years ago
examples Add test harness 4 years ago
pyircbot More tests 4 years ago
tests Update docs with testing info 4 years ago
.gitignore tests 4 years ago
README.md Update docs with testing info 4 years ago
requirements-test.txt More tests 4 years ago
run-example.sh Add test harness 4 years ago
run-tests.sh More tests 4 years ago
setup.py fix unicode error 4 years ago

README.md

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

Tests

PyIRCBot has great test coverage. After installing the contents of requirements-test.txt, the script ./run-tests.sh will run all tests. See the contents of the script for more information. See README.md in ./tests/ for more info.

TODO

  • Improve/complete docs
  • Write config checker