This is an IRC bot developed by members of HackSoc to provide various features in the #cs-york channel on Freenode.

csbot is written for Python 3.4 and based on the asyncio library which became part of the Python standard library in 3.4. It may also work on Python 3.3 with the asyncio package installed, but this is currently untested.

It's recommend to develop within a virtual environment. This should get you up and running¹:

$ virtualenv -p python3 venv3
$ source venv3/bin/activate
$ pip install -r requirements.txt
$ ./run_csbot.py --help

Look at csbot.deploy.cfg for an example of a bot configuration.

If you want to develop features for the bot, create a uniquely named plugin (see csbot/plugins/ for examples), try it out, preferably write some unit tests (see csbot/test/plugins/) and submit a pull request.

The code is documented to varying degrees, and Sphinx-based documentation is automatically generated on Read the Docs: http://hacksoc-csbot.readthedocs.org. Of particular use is the "How to write plugins" section.

You can build the documentation yourself with:

$ pip install sphinx
$ cd docs/
$ make html

csbot has some unit tests. (It'd be nice to have more.) To run them:

$ ./run_tests.py

We're also using Travis-CI for continuous integration and continuous deployment.