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.

47 lines
1.3 KiB

7 years ago
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`
7 years ago
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.
7 years ago
Building Docs
-------------
7 years ago
* Install sphinx and all modules pyircbot depends on
* `cd docs ; make html`
* Open _build/index.html
7 years ago
Or, use my pre-built copy [here](http://davepedu.com/files/botdocs/).
Alternatively, use the included Dockerfile to create an environment for building the docs. Check
`docs/builder/README.md`.
7 years ago
7 years ago
Developing Modules
------------------
7 years ago
Check *Module Developer’s Guide* in the docs
7 years ago
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.
7 years ago
TODO
----
7 years ago
* Improve/complete docs
7 years ago
* Write config checker