Extending Allura with Entry Points

There are many extension points to extending Allura. They all make themselves known to Allura via python entry points defined in setup.py. Many are then available immediately. Others, such as authentication providers or themes, need to be specified in your .ini file, since you may only have one enabled at a time.

The available extension points for Allura are:

• :class:`allura.app.Application` (aka tool) and :class:`allura.app.Artifact`
• :class:`allura.lib.plugin.ThemeProvider`
• :class:`allura.lib.plugin.ProjectRegistrationProvider`
• :class:`allura.lib.plugin.AuthenticationProvider`
• :class:`allura.lib.plugin.UserPreferencesProvider`
• :class:`allura.lib.plugin.AdminExtension`
• :class:`allura.lib.spam.SpamFilter`
• site_stats in the root API data. Docs in :class:`allura.controllers.rest.RestController`
• :mod:`allura.lib.package_path_loader` (for overriding templates)

A listing of available 3rd-party extensions is at https://sourceforge.net/p/allura/wiki/Extensions/

Other entry points are used to provider paster commands and easy_widget configuration.

Event Handlers

Another way to extend Allura is set up event handlers to respond to Allura events. There is documentation and examples at :ref:`events`.

The events that allura publishes are:

• project_created
• project_updated
• repo_cloned
• repo_refreshed
• repo_clone_task_failed