Probot

Probot is an IRC bot written in Python 3 with a versatile plugin architecture that's getting better all the time. Currently, Python 3.2 and later are supported.

Features

Probot has many features. Some of them are downright silly and useless. Others are actually useful.

Here's what Probot can offer your users:
Lightweight and Quick - Despite relying on a Python interpreter, Probot is lightweight, and doesn't require much resources. On a default install with everything enabled, Probot uses less than 30 MB of memory.
Reliable - Probot has over 1500 hours of continual usage (without crashing) under it's belt. Even in the unlikely event that something does go wrong, Probot will automatically recover from faulty plugins or internal errors.
Do No Spam - Probot doesn't spam send messages to public chat unless necessary to avoid being annoying.

Here's what Probot's got for admins and devs:
Hack 'N Slash - Probot's plugin system is designed to be easy to use by handling hard work for you. It has been thoughtfully designed to be Pythonic and simple to use.
Reload on the fly - Probot is able to :reload, :disable, and :enable plugins on the fly. It's also able to :restart quickly should the need arise.
Programmable Regular Expressions - With Probot, you can make regular expressions trigger behavior with plugins. For example, you could make a plugin that detects when users say Linux, and kindly remind them that they're actually referring to GNU/Linux (mumble, mumble RMS).
Configurable Command Prefixes - If you'd like to use Probot and have commands like !this or .this, then you can easily change the command prefix in the configuration.

In case that doesn't convince you, here's the laundry list of what Probot's got:

Laundry List

• Asynchronous for snappy performance
• Multiple channel support
• Easily to install plugins to add commands and functionality.
  • No need to restart the bot, just run :reload!
• Login to a reserved nickname (ie NickServ)
  • Wait for cloak or vHost before connecting to channel
• Custom command prefixes (eg . or ! or >)
• Command aliases - :convert can become :c
• Command throttling (via cooldowns per command)
• Built-in commands:
  • :auth - authenticate yourself as a bot operator
  • :help - get psychiatric counseling
  • :commands - list available commands
  • :test - check to see if the bot is working
  • :info - display version and bot information
  • :reload - reload plugins on the fly! (admins only)
  • :join - join a channel (admins only)
  • :stop - stop this irc bot (admins only)
  • :log - write something to log (admins only)
  • :plugins - list available plugins
  • :plugin - get information about a plugin
  • :restart - restarts the bot
  • :channels - list channels currenly in (admins only)
  • :join - join a channel (admins only)
  • :part - leave a channel (admins only)
  • :enable - enables a plugin
  • :disable - disables a plugin
• Default plugin commands:
  • :calc - simple calculator
  • :convert - currency conversion
  • :currencies - list available currencies to convert between
  • :fortune - just like the *nix command! (fortune must be installed on system)
    • :cowsay - Get a fortune via cowsay (cowsay must be installed)
  • :[not]told - get #told
  • :[not]rekt - get #rekt
  • :partyboat - start the party boat
  • :uptime - get current uptime for the bot
  • :stats - get statistics about the bot (for this session)
  • :whatis - look up the long name for a currency identifier
  • :wiki - search wikipedia for a term
• Plugins to recognize text
  • Link identifier
    • Customized feedback about YouTube, Imgur, Reddit, Hydra Paste, and more!
    • Display file sizes and types (e.g. PDF, ISO, ZIP, GZIP)
    • Many more sites
  • Responses to complements, greetings, and mean words from users
• Substitution plugin
  • Fix typos just by typing s/tpyo/typo/ like you would in Vim

In-Progress

• General Cleanup of Global Variables
• Syntactical Sugar for Plugins

Planned

• Google search plugin (:google)
• Translation plugin (:translate)
• Multi-Network support
• RSS Reader to change channel topic periodically
• Persist disabled and enabled plugins between restarts
• Dictionary plugin (:def)
• Games (Just silly IRC games)

Setup

Installing and Running

The setup is very simple. Install some modules and you're good!

1. Copy this code to somewhere on your computer.
2. Install required pip modules: pip install requests bs4 should do it. Use a virtualenv if you want.
3. Copy config.template.json to config.json.
4. Edit config.json to your liking. The options are self-explanatory.
5. If you aren't using the OpenExchangeRates API, then disable the plugin or all hell will break loose. You can do that by changing __plugin_enabled__ in plugins/convert.py to False.
6. Run ./probot.py to start the bot.
7. ???
8. PROFIT!!!

Installing Plugins

To install a plugin, simply drop it in the plugins directory. If probot is running, the plugin can be loaded by simply using the :reload command.

Creating a Plugin

To create a plugin, create a copy of plugins/template.py, and read the included instructions on how to create a plugin. You are free to use this template, given that it is released under the same license as this project.

About

This is an IRC bot written in Python 3. The aim of Probot is to be responsive, fast, and easily extended. Probot strives to be an example of what quality Python code looks like. Moreover, it should give new programmers to the Python language an idea of what you can do with a little bit of knowledge and of free time.

Probot is written for maximum lulz and utility. It probably has more features than it should have. Oh well! The feature creep will only expand in the future!

License

All of this code is licensed under the GNU Affero License Version 3 or any later version. The full text of this license can be found in the LICENSE file.