Skip to main content
Ctrl+K

Xpublish 0.5.0

  • Getting started
  • User Guide
  • API reference
  • Ecosystem
  • Contributing
  • GitHub
  • Getting started
  • User Guide
  • API reference
  • Ecosystem
  • Contributing
  • GitHub

Section Navigation

  • API Endpoints
  • Included Plugins
    • xpublish.plugins.included.dataset_info.DatasetInfoPlugin
    • xpublish.plugins.included.module_version.ModuleVersionPlugin
    • xpublish.plugins.included.plugin_info.PluginInfoPlugin
  • Plugins
    • xpublish.Plugin
    • xpublish.hookimpl
    • xpublish.hookspec
    • xpublish.Dependencies
    • xpublish.plugins.hooks.PluginSpec
    • xpublish.plugins.manage.find_default_plugins
    • xpublish.plugins.manage.load_default_plugins
    • xpublish.plugins.manage.configure_plugins
  • xpublish.Rest
  • xpublish.Rest.app
  • xpublish.Rest.cache
  • xpublish.Rest.plugins
  • xpublish.Rest.serve
  • xpublish.Rest.register_plugin
  • xpublish.Rest.dependencies
  • xpublish.Rest.setup_datasets
  • xpublish.Rest.get_datasets_from_plugins
  • xpublish.Rest.get_dataset_from_plugins
  • xpublish.Rest.get_datatree_from_plugins
  • xpublish.Rest.setup_plugins
  • xpublish.Rest.init_cache_kwargs
  • xpublish.Rest.init_app_kwargs
  • xpublish.Rest.plugin_routers
  • xpublish.SingleDatasetRest
  • xpublish.SingleDatasetRest.setup_datasets
  • xpublish.SingleDatasetRest
  • xarray.Dataset.rest
  • xarray.Dataset.rest.app
  • xarray.Dataset.rest.cache
  • xarray.Dataset.rest.serve
  • xarray.DataTree.rest
  • xarray.DataTree.rest.app
  • xarray.DataTree.rest.cache
  • xarray.DataTree.rest.serve
  • xpublish.dependencies.get_dataset_ids
  • xpublish.dependencies.get_dataset
  • xpublish.dependencies.get_datatree
  • xpublish.dependencies.get_cache
  • xpublish.dependencies.get_plugins
  • xpublish.dependencies.get_plugin_manager
  • API reference
  • Included Plugins
  • xpublish.plugins.included.plugin_info.PluginInfoPlugin

xpublish.plugins.included.plugin_info.PluginInfoPlugin#

pydantic model xpublish.plugins.included.plugin_info.PluginInfoPlugin[source]#

Expose the currently loaded plugins and their versions.

Fields:
  • app_router_prefix (str)

  • app_router_tags (Sequence[str])

  • name (str)

field app_router_prefix: str = ''#
field app_router_tags: Sequence[str] = ['plugin_info']#
field name: str = 'plugin_info'#
app_router(deps)[source]#

Returns the router for plugin info metadata.

Return type:

APIRouter

previous

xpublish.plugins.included.module_version.ModuleVersionPlugin

next

Plugins

On this page
  • PluginInfoPlugin
    • PluginInfoPlugin.app_router_prefix
    • PluginInfoPlugin.app_router_tags
    • PluginInfoPlugin.name
    • PluginInfoPlugin.app_router()
Edit on GitHub
Show Source

© Copyright 2019 onwards, Joe Hamman and its Contributors.

Created using Sphinx 7.4.7.

Built with the PyData Sphinx Theme 0.17.1.