Plugin API Reference¶
The Plugin API is versioned in sync with pulpcore
and consists of everything importable within the
pulpcore.plugin
namespace. It is governed by our deprecation policy.
When writing plugins, care should be taken to only import pulpcore
components exposed in this
namespace; importing from elsewhere within the pulpcore
module (e.g. importing directly from
pulpcore.app
, pulpcore.exceptions
, etc.) is unsupported, and not protected by the
aforementioned Pulp Plugin API deprecation policy.
- class pulpcore.plugin.PulpPluginAppConfig(app_name, app_module)¶
AppConfig class. Use this in plugins to identify your app as a Pulp plugin.
- import_modelresources()¶
If a plugin has a modelresource.py, import it
(This exists when a plugin knows how to import-export itself)
- import_urls()¶
If a plugin defines a urls.py, include it.
- ready()¶
Override this method in subclasses to run code when Django starts.