Plugin system overview


For RepoBee to discover a plugin and its hooks, the following conventions need to be adhered to:

  1. The PyPi package should be named repobee-<plugin>, where <plugin> is the name of the plugin.
  2. The actual Python package (i.e. the directory in which the source files are located) should be called repobee_<plugin>. In other words, replace the hyphen in the PyPi package name with an underscore.
  3. The Python module that defines the plugin’s hooks/hook classes should be name <plugin>.py.

For an example plugin that follows these conventions, have a look at repobee-junit4. Granted that the plugin follows these conventions and is installed, it can be loaded like any other RepoBee plugin (see Using Existing Plugins).


There are two types of hooks in RepoBee: core hooks and extension hooks.

Core hooks

Core hooks provide core functionality for RepoBee, and always have a default implementation in repobee.ext.defaults. Providing a different plugin implementation will override this behavior, thereby changing some core part of RepoBee. In general, only one implementation of a core hook will run per invocation of RepoBee. All core hooks are defined in repobee_plug.corehooks.


Note that the default implementations in repobee.ext.defaults may simply be imported into the module. They are not necessarily defined there.

Extension hooks

Extension hooks extend the functionality of RepoBee in various ways. Unlike the core hooks, there are no default implementations of the extension hooks, and multiple implementations can be run on each invocation of RepoBee. All extension hooks are defined in repobee_plug.exthooks.