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.

• pulpcore.plugin.models
• pulpcore.plugin.serializers
• pulpcore.plugin.storage
• pulpcore.plugin.viewsets
• pulpcore.plugin.tasking
• pulpcore.plugin.download
  • Basic Downloading
  • Parallel Downloading
  • Download Results
  • Configuring from a Remote
  • Automatic Retry
  • Exception Handling
  • Custom Download Behavior
  • Adding New Protocol Support
  • Download Factory
  • HttpDownloader
  • FileDownloader
  • BaseDownloader
  • Validation Exceptions
• pulpcore.plugin.stages
  • DeclarativeVersion
  • Stages API
  • Artifact Related Stages
  • Content Related Stages
  • Content Association and Unassociation Stages
• Profiling the Stages API Performance
  • Summarizing Performance Data
  • Profiling API Machinery
• pulpcore.plugin.content
  • Creating your Handler
  • Registering your Handler
  • Restricting which detail Distributions Match
  • pulpcore.plugin.content.Handler

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.