Commands

pmxbot listens to commands prefixed by a ‘!’
If it’s a command, it knows it will reply, take an action, etc.
It can search the web, store quotes you, track karma, make decisions,
and do just about anything else you could want. It stores logs and quotes
and karma in either a sqlite or MongoDB
database, and there’s a web interface for reviewing the logs and karma.

Contains

pmxbot will respond to things you say if it detects words and phrases it’s
been told to recognize. For example, mention sql on rails.

Requirements

pmxbot requires Python 2.7 or later (including Python 3). It also requires a
few python packages as defined in setup.py.

If using the MongoDB backend, it requires pymongo (otherwise, sqlite will
be used).

Testing

pmxbot includes a test suite that does some functional tests written against
the Python IRC server and quite a few unit tests as well. Just run them
from the pmxbot root directory using “py.test”
(requires pytest) and it should do it all for you.

Configuration

Configuration is based on very easy YAML files. Check out config.yaml in the
source tree for an example.

Usage

Once you’ve setup a config file, you just need to call pmxbot config.yaml
and it will join and connect. We recommend running pmxbot under
daemontools, upstart, supervisord, or your favorite supervisor to make it
automatically restart if it crashes (or terminates due to a planned
restart).

Custom Features

Setuptools Entry Points Plugin

pmxbot provides an extension mechanism for adding commands, and uses this
mechanism even for its own built-in commands.

To create a setuptools (or distribute or compatible packaging tool)
entry point plugin, package your modules using
the setuptools tradition and install it alongside pmxbot. Your package
should define an entry point in the group pmxbot_handlers by including
something similar to the following in the package’s setup.py:

During startup,
pmxbot will load mylib.mymodule. plugin name can be anything, but should
be a name suitable to identify the plugin (and it will be displayed during
pmxbot startup).

If your plugin requires any initialization, specify an initialization function
(or class method) in the entry point. For example:

'plugin name = mylib.mymodule:initialize_func'

On startup, pmxbot will call initialize_func with no parameters.

Within the script you’ll want to import the decorates you need to use with:
from pmxbot.core import command, contains, regexp, execdelay, execat. You’ll
then decorate each function with the appropriate line so pmxbot registers it.

Web Interface

pmxbot includes a web server for allowing users to view the logs, read the
help, and check karma. You specify the host, port, base path, logo, title,
etc with the same YAML config file. Just run like pmxbotweb config.yaml
and it will start up. Like pmxbot, use of a supervisor is recommended to
restart the process following termination.