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 Pedu 13ea0fe52f
Merge pull request #3 from r3cursive/patch-1
2 years ago
docs Add stockindex module 2 years ago
examples add announce channel 3 years ago
pyircbot Update StockIndex.py 2 years ago
tests add replyto field to privmsg ircevent messages 2 years ago
tools Add metadata interchange to pubsub mode 5 years ago
.dockerignore Docs update 4 years ago
.gitignore Ignore test asciis 5 years ago
Dockerfile Move dockerfile 4 years ago
README.md Update docs with testing info 5 years ago
requirements-test.txt Docs update 4 years ago
requirements.txt Docs update 4 years ago
run-example.sh py 3.7 4 years ago
run-tests.sh Move dockerfile 4 years ago
setup.py Add 24h historical loss/gain to StockPlay 4 years ago

README.md

This file contains ambiguous Unicode characters!

This file contains ambiguous Unicode characters that may be confused with others in your current locale. If your use case is intentional and legitimate, you can safely ignore this warning. Use the Escape button to highlight these characters.

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 Developers 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