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.
|
8 years ago | |
---|---|---|
bin | 8 years ago | |
docs | 8 years ago | |
examples | 8 years ago | |
pyircbot | 8 years ago | |
.gitignore | 8 years ago | |
README.md | 8 years ago | |
setup.py | 8 years ago |
README.md
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
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
- Add a way to pass additional directories where modules are stored