Skip to main content

IRC bot - full featured, yet extensible and customizable

Project description


pmxbot is an IRC bot written in python. Originally built for internal use, it’s been sanitized and set free upon the world. You can find out more details on the website,, and especially the wiki


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.


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.


pmxbot requires Python 3. It also requires a few python packages as defined in

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


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 is based on very easy YAML files. Check out config.yaml in the source tree for an example.


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

entry_points = {
    'pmxbot_handlers': [
        'plugin name = mylib.mymodule',

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.

A command (!g) gets the @command decorator:

@command(aliases=('tt', 'tear', 'cry'))
def tinytear(client, event, channel, nick, rest):
  "I cry a tiny tear for you."
  if rest:
    return "/me sheds a single tear for %s" % rest
    return "/me sits and cries as a single tear slowly trickles down its cheek"

A response (when someone says something) uses the @contains decorator:

def yay_sor(client, event, channel, nick, rest):'sql on rails', 1)
  return "Only 76,417 lines..."

A more complicated response (when you want to extract data from a message) uses the @regexp decorator:

@regexp("jira", r"(?<![a-zA-Z0-9/])(OPS|LIB|SALES|UX|GENERAL|SUPPORT)-\d\d+")
def jira(client, event, channel, nick, match_obj):
  return "" %

For an example of how to implement a setuptools-based plugin, see one of the many examples in the pmxbot project itself or one of the popular third-party projects:

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.

Project details

Release history Release notifications

Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
pmxbot-1111.0.tar.gz (192.1 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page