dave
/
pyircbot
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity
Awesome IRC bot
237 Commits 2 Branches 0 Tags 4.3 MiB
Python 99.8%
Go to file
dave 3b6d4ff33d ModInfo test 2018-02-12 21:33:18 -08:00
bin Add metadata interchange to pubsub mode 2018-01-16 18:24:32 -08:00
docs Prettify help text layouts 2018-02-10 19:52:32 -08:00
examples Handle crypto reserve as decimal not float 2018-02-10 19:49:17 -08:00
pyircbot ModInfo test 2018-02-12 21:33:18 -08:00
tests ModInfo test 2018-02-12 21:33:18 -08:00
tools Add metadata interchange to pubsub mode 2018-01-16 18:24:32 -08:00
.gitignore tests 2017-12-03 00:20:08 -08:00
README.md Update docs with testing info 2017-12-03 21:14:18 -08:00
requirements-test.txt Add DCC module 2018-01-16 18:24:32 -08:00
requirements.txt Make requirements and docbuilder simpler 2018-02-10 15:57:39 -08:00
run-example.sh Add DCC module 2018-01-16 18:24:32 -08:00
run-tests.sh Add tests for cryptowallet 2018-02-10 18:29:07 -08:00
setup.py fix unicode error 2017-10-12 23:35:42 -07:00

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