MetaBrainz Foundation

Update documentation for BrainzBot plugin API

BrainzBot is the bot that logs our IRC channels and also handles some other things like linking to JIRA tickets whenever they are mentioned and helping us tell people we appreciate their work.

All those different functions are implemented as plugins. We've recently made a few changes to BrainzBot's plugin API but the documentation hasn't been updated to include the new command listeners. The section on how to store data in Redis should also be expanded.

You may have to spend a few hours digging into the relevant code in both brainzbot-core and brainzbot-plugins, check out the jira and metabrain plugin for some applications of the new command listeners. Knowing regular expressions might also be useful as it allows you to understand what's actually going on there.

The relevant documentation file is on GitHub and is rendered using Read the Docs but you can use a local rST renderer (Atom probably has a plugin for that) or the GitHub preview if you decide to edit online to see your what your changes look like.

Task tags

  • python
  • brainzbot
  • irc
  • restructured text
  • documentation

Students who completed this task

Eshan Singh

Task type

  • code Code
  • chrome_reader_mode Documentation / Training
close

2017