A bot written by the TJHSST CSL for IRC.

To quote the GPL:

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE."

That said, the bot devs hangout in #tjcsl-cslbot on freenode and are usually happy to answer your questions.

See http://tjcsl.github.io/cslbot for api docs.

Copy config.example to config.cfg and change values as needed.

Python must be at least 3.3.

Hard mode:

1. Install irc (https://pypi.python.org/pypi/irc),

2. beautiful soup (http://www.crummy.com/software/BeautifulSoup/)

3. lxml (https://pypi.python.org/pypi/lxml),

4. requests (https://pypi.python.org/pypi/requests),

5. IRC (http://pypi.python.org/pypi/irc)

6. and sqlalchemy (https://pypi.python.org/pypi/SQLAlchemy).

Easy mode:

If you have Pip installed, you can simply run pip install -r requirements.txt

You must also install the appropriate DBAPI package as explained in the next section (unnecessary if you're using SQLite).

Note: the init script (scripts/ircbot) is gentoo/openrc specific.

Example configurations:

1. PostgreSQL - engine: postgresql://ircbot:dbpass@localhost/dbname

2. SQLite - engine: sqlite:///db.sqlite

See: http://docs.sqlalchemy.org/en/rel_0_9/core/engines.html for more information on SQLAlchemy database engine URLs.

If you intend to use SQLite, the default DBAPI is provided by a built-in python module (sqlite3), so you don't need to install any additional packages.

If you intend to use PostgreSQL, the default DBAPI is provided by the psycopg2 package (https://pypi.python.org/pypi/psycopg2)

If you intend to use MySQL, the default DBAPI is provided by the mysql-python package (https://pypi.python.org/pypi/MySQL-python)

See the SQLAlchemy documentation if you want to use another backend.

To add a module place a .py file in the commands dir.
The file must contain a method that is decorated with the @Command decorator; this is used in the form @Command(['command_name_1', 'command_name_2'], ['arg_required_1', 'arg_required_2']). The file will only be run if it is marked executable.

PLEASE NOTE!
The !steam command will not work without a valid Steam API key
and a file steamids.pickle which contains a dictionary mapping username
to STEAMID64. An example steamid mapping file is provided in the static folder.
For this reason the !steam command is disabled by default;
to re-enable it add your Steam API key as STEAMAPIKEY in config.py.

This python script parses the db and generates jinja2-templated html files containing quotes, score, polls, etc. It is intended to be used as a cronjob with a webserver to serve quotes over HTTP.

This script parses the logs and generates human-readable logs for each channel the bot is in. It is intended to be used as a cronjob to generate and optionally make available logs.

Licensed under the GPL v2
Created by fwilson (Fox Wilson, Class of 2016).
Rewritten by pfoley (Peter Foley, Class of 2013).
Improved by sdamashek (Samuel Damashek, Class of 2017).
Improved by bob_twinkles (Reed Koser, Class of 2015).
Improved by csssuf.
Improved by skasturi. (Srijay Kasturi)
Criticized by creffett. (Chris Reffett, Class of 2011).