xpublish.Plugin

pydantic model xpublish.Plugin

Xpublish plugins provide ways to extend the core of xpublish with new routers and other functionality.

To create a plugin, subclass Plugin and add attributes that are subclasses of PluginType (Router for instance).

The specific attributes correspond to how Xpublish should use the plugin.

Show JSON schema

{
   "title": "Plugin",
   "description": "Xpublish plugins provide ways to extend the core of xpublish with new routers and other functionality.\n\nTo create a plugin, subclass `Plugin` and add attributes that are\nsubclasses of `PluginType` (`Router` for instance).\n\nThe specific attributes correspond to how Xpublish should use\nthe plugin.",
   "type": "object",
   "properties": {
      "name": {
         "title": "Name",
         "description": "Fallback name of plugin",
         "type": "string"
      }
   },
   "required": [
      "name"
   ]
}

Fields:

• name (str)

field name: str [Required]

Fallback name of plugin