Plugin API Reference

The Plugin API is versioned separately from the Pulp Core and consists of everything importable within the pulpcore.plugin namespace. When writing plugins, care should be taken to only import Pulp Core components exposed in this namespace; importing from elsewhere within the Pulp Core (e.g. importing directly from pulpcore.app, pulpcore.exceptions, etc.) is unsupported, and not protected by the Pulp Plugin API’s semantic versioning guarantees.

Warning

Exactly what is versioned in the Plugin API, and how, still has yet to be determined. This documentation will be updated to clearly identify what guarantees come with the semantic versioning of the Plugin API in the future. As our initial plugins are under development prior to the release of Pulp 3.0, the Plugin API can be assumed to have semantic major version 0, indicating that it is unstable and still being developed.

exception pulpcore.plugin.PulpException(error_code)

Base exception class for Pulp.

Parameters:error_code (str) – unique error code
http_status_code = 500
class pulpcore.plugin.PulpPluginAppConfig(app_name, app_module)

AppConfig class. Use this in plugins to identify your app as a Pulp plugin.

import_serializers()
import_urls()

If a plugin defines a urls.py, include it.

import_viewsets()
ready()

Override this method in subclasses to run code when Django starts.