err

err is a plugin-based XMPP chatbot designed to be easily deployable, extensible and maintainable. It is written in python and it is based on jabberbot_ and yapsy_ with some minor modifications for the first one.

Features:

• Tested with hipchat_ and openfire_ but should be compatible with any XMPP/Jabber servers.
• Can be setup so a restricted list of persons have the administration rights
• Dynamic plugin architecture : the bot admin can install/uninstall/enable/disable plugins dynamically just by chatting with the bot.
• Supports MUCs (chatrooms)
• Can proxy and route one 2 one messages to MUC so it can enabler simpler XMPP notifiers to be MUC compatible (for example the jira XMPP notifier).
• Really easily extensible (see example below)
• Provides an an automatic persistance store per plugin
• an !help command that generate dynamically the documentation from the python docstrings of the commands

What is new in this release:

• Features:
• SSL support for webhook callbacks
• JID unicode support
• Per user command history (Thanks to Leonid S. Usov https://github.com/leonid-s-usov)
• HIDE_RESTRICTED_COMMANDS option added to filter out the non accessoble commands from the help (Thanks to Leonid S. Usov https://github.com/leonid-s-usov)
• err-markovbot has been added to the official plugins list (Thanks to Max Wagner https://github.com/MaxWagner)
• the version parsing now supports beta, alpha, rc etc ... statuses
• Major refactoring:
• python 3 compatibility
• xmpp backend has been replaced by sleekxmpp
• flask has been replaced by bottle (sorry flask no py3 support, no future)
• rocket is used as webserver with SSL support
• now the IRC backend uses the smpler python/irc package
• improved unittest coverage

What is new in version 1.6.7:

• Bugs:
• the XMPP from was not removed as it should and broke the gtalk compatibility
• fixed 'jid-malformed' error with build_reply()
• Features:
• new plugin : err-dnsutils https://github.com/zoni/err-dnsutils
• Now you can selectively divert chatroom answers from a list of specified commands to a private chat (avoids flooding on IRC for example)
• the logging can be done using sentry
• Err can now login using SSL on IRC (thx to Dan Poirier https://github.com/poirier)

What is new in version 1.6.5:

• Bugs:
• https://github.com/gbin/err/issues/59 [Thx to https://github.com/bubba-h57 & https://github.com/zoni for helping to diagnose it]
• Features:
• The graphical backend now uses a multiline chat to better reflect some backends.

What is new in version 1.6.4:

• Bugs:
• Identity stripping problems
• fixed warn_admin that regressed
• close correctly shelves on connection drop [Thx to linux techie https://github.com/linuxtechie]
• corrected the !status reporting was was incorrect for non configured plugins (label C)
• force a complete reconnection on "See Other Host" XMPP message
• Features:
• You can now change the default prefix of the bot (new config BOT_PREFIX) [Thx to Ciaran Gultnieks https://github.com/CiaranG]
• Added an optional threadpool to execute commands in parallel (Experimental, new config : BOT_ASYNC)
• Now the bot wait on signal USR1 so you can do a kill -USR1 PID of err to make it spawn a local python console to debug it live
• Now you can have several config_*.py, one per backend (to be able to test specifically a backend without having to reconfigure each time the bot)

What is new in version 1.6.3:

• Bugs:
• !reload was causing a crash on templating
• !update was failing on internal_shelf
• several consistency fixups around Identity and Message, now they should behave almost the same was across all the backends
• corrected several unicode / utf-8 issues across the backends
• unified the standard xmpp and hipchat keep alive, they work the same
• Features:
• added err-timemachine, an "history" plugin that logs and indexes every messages. You can query it with a lucene syntax over specific dates etc ...
• Added a webserver UI from the webserver builtin plugin (disabled by default see !config webserver to enable it)
• Now if a config structure changed or failed, the bot will present you the config you had and the default template so you can adapt your current config easily
• Added the schema for xhtml-im so you can use your favorite xml editor to check what your templates are generating

What is new in version 1.6.2:

• Bugs:
• missing a dependency for python config [thx to Joshua Tobin https://github.com/joshuatobin]
• Fixing two logging debug statements that are mixed up [thx to Joshua Tobin https://github.com/joshuatobin]
• Removed the URL rewritting from the QT user interface
• Features:
• Added basic IRC support
• Now the BOT_EXTRA_PLUGIN_DIR can be a list so you can develop several plugins at the same time

What is new in version 1.6.0:

• Bugs:
• corrected a threading issue that was preventing err to quit
• the python shebangs lines where not generic
• the config path is not inserted first so we don't conflict with other installs
• corrected a corruption of the configs on some persistance stores on shutdown
• Features:
• Added support for CampFire (see: https://github.com/gbin/err/wiki/Setup-with-CampFire)
• Added support for Hipchat API with basic html messages (https://github.com/gbin/err/wiki/Setup-with-Hipchat)
• Added support for webhooks (see: https://github.com/gbin/err/wiki/webhooks)
• Independent backends can be implemented
• In order to simplify : now botcmd and BotPlugin are both imported from errbot (we left a big fat warning for the old deprecated spot, they will be removed in next release)
• Better status report from !status (including Errors and non-configured plugins)

What is new in version 1.5.1:

• The pypi package was not deploying html templates

What is new in version 1.4.1:

• Bugs:
• corrected a vicious bug when you use metaclasses on plugins with botcmd decorator generated with parameters
• don't call any callback message if the message is from the chat history
• dependency problem with dnspython, it fixes the compatibility with google apps [Thx to linux techie https://github.com/linuxtechie]
• on repos updates, err now recheck the dependencies (you never know if they changed after the update)
• Features:
• Added a new check_configuration callback now by default the configuration check is basic and no implementation has to be done on plugin side
• Warn the admins in case of command name clashes and fix them by prefixing the name of the plugin + -
• A brand new graphical mode so you can debug with images displayed etc ... (command line option -G) it requires pyside
• A new !apropos command that search a term into the help descriptions [thx to Ben Van Daele https://github.com/benvd]
• Now the bot reconnects in case of bad internet connectivity [Thx to linux techie https://github.com/linuxtechie]
• The bot now supports a "remote chatroom relay" (relay all messages from a MUC to a list of users) on top of a normal relay (from a user to a list of MUC)
• With this you can emulate a partychat mode.
• err-music [thx to Ben Van Daele https://github.com/benvd and thx to Tali Petrover https://github.com/atalyad]

Requirements:

• Python