niamoto.core package

Subpackages

• niamoto.core.plugins package
  • Subpackages
    • niamoto.core.plugins.exporters package
      • Submodules
      • niamoto.core.plugins.exporters.dwc_archive_exporter module
      • niamoto.core.plugins.exporters.html_page_exporter module
      • niamoto.core.plugins.exporters.index_generator module
      • niamoto.core.plugins.exporters.json_api_exporter module
      • Module contents
    • niamoto.core.plugins.loaders package
      • Submodules
      • niamoto.core.plugins.loaders.adjacency_list module
      • niamoto.core.plugins.loaders.api_taxonomy_enricher module
      • niamoto.core.plugins.loaders.direct_reference module
      • niamoto.core.plugins.loaders.direct_reference_legacy module
      • niamoto.core.plugins.loaders.join_table module
      • niamoto.core.plugins.loaders.nested_set module
      • niamoto.core.plugins.loaders.spatial module
      • niamoto.core.plugins.loaders.stats_loader module
      • Module contents
    • niamoto.core.plugins.transformers package
      • Subpackages
      • Module contents
    • niamoto.core.plugins.widgets package
      • Submodules
      • niamoto.core.plugins.widgets.bar_plot module
      • niamoto.core.plugins.widgets.concentric_rings module
      • niamoto.core.plugins.widgets.diverging_bar_plot module
      • niamoto.core.plugins.widgets.donut_chart module
      • niamoto.core.plugins.widgets.hierarchical_nav_widget module
      • niamoto.core.plugins.widgets.info_grid module
      • niamoto.core.plugins.widgets.interactive_map module
      • niamoto.core.plugins.widgets.line_plot module
      • niamoto.core.plugins.widgets.plotly_utils module
      • niamoto.core.plugins.widgets.radial_gauge module
      • niamoto.core.plugins.widgets.raw_data_widget module
      • niamoto.core.plugins.widgets.scatter_plot module
      • niamoto.core.plugins.widgets.stacked_area_plot module
      • niamoto.core.plugins.widgets.summary_stats module
      • niamoto.core.plugins.widgets.sunburst_chart module
      • niamoto.core.plugins.widgets.table_view module
      • Module contents
  • Submodules
  • niamoto.core.plugins.base module
    • PluginType
      • PluginType.TRANSFORMER
      • PluginType.EXPORTER
      • PluginType.WIDGET
      • PluginType.LOADER
      • PluginType.DEPLOYER
    • Plugin
      • Plugin.type
      • Plugin.resolve_entity_table()
    • LoaderPlugin
      • LoaderPlugin.type
      • LoaderPlugin.load_data()
    • TransformerPlugin
      • TransformerPlugin.type
      • TransformerPlugin.output_structure
      • TransformerPlugin.transform()
      • TransformerPlugin.prepare_batch()
    • ExporterPlugin
      • ExporterPlugin.type
      • ExporterPlugin.export()
    • WidgetPlugin
      • WidgetPlugin.type
      • WidgetPlugin.compatible_structures
      • WidgetPlugin.get_dependencies()
      • WidgetPlugin.render()
      • WidgetPlugin.get_container_html()
    • DeployerPlugin
      • DeployerPlugin.type
      • DeployerPlugin.deploy()
      • DeployerPlugin.unpublish()
      • DeployerPlugin.validate_exports()
      • DeployerPlugin.sse_log()
      • DeployerPlugin.sse_error()
      • DeployerPlugin.sse_success()
      • DeployerPlugin.sse_url()
      • DeployerPlugin.sse_done()
    • register()
  • niamoto.core.plugins.exceptions module
    • PluginError
    • PluginRegistrationError
    • PluginNotFoundError
    • PluginConfigError
    • PluginLoadError
    • PluginValidationError
    • PluginExecutionError
    • PluginDependencyError
    • PluginTypeError
    • PluginStateError
  • niamoto.core.plugins.models module
    • BasePluginParams
      • BasePluginParams.model_config
    • PluginConfig
      • PluginConfig.plugin
      • PluginConfig.source
      • PluginConfig.params
      • PluginConfig.model_config
    • WidgetLayoutConfig
      • WidgetLayoutConfig.colspan
      • WidgetLayoutConfig.order
      • WidgetLayoutConfig.model_config
    • WidgetConfig
      • WidgetConfig.plugin
      • WidgetConfig.data_source
      • WidgetConfig.title
      • WidgetConfig.description
      • WidgetConfig.params
      • WidgetConfig.layout
      • WidgetConfig.model_config
    • SiteConfig
      • SiteConfig.model_config
      • SiteConfig.title
      • SiteConfig.logo_header
      • SiteConfig.logo_footer
      • SiteConfig.lang
      • SiteConfig.languages
      • SiteConfig.language_switcher
      • SiteConfig.primary_color
      • SiteConfig.nav_color
    • NavigationItem
      • NavigationItem.text
      • NavigationItem.url
      • NavigationItem.children
      • NavigationItem.model_config
    • FooterLink
      • FooterLink.text
      • FooterLink.url
      • FooterLink.external
      • FooterLink.model_config
    • FooterSection
      • FooterSection.title
      • FooterSection.links
      • FooterSection.model_config
    • StaticPageContext
      • StaticPageContext.title
      • StaticPageContext.content_source
      • StaticPageContext.model_config
    • StaticPageConfig
      • StaticPageConfig.name
      • StaticPageConfig.template
      • StaticPageConfig.output_file
      • StaticPageConfig.context
      • StaticPageConfig.model_config
    • HtmlExporterParams
      • HtmlExporterParams.model_config
      • HtmlExporterParams.template_dir
      • HtmlExporterParams.output_dir
      • HtmlExporterParams.base_template
      • HtmlExporterParams.copy_assets_from
      • HtmlExporterParams.site
      • HtmlExporterParams.navigation
      • HtmlExporterParams.footer_navigation
      • HtmlExporterParams.include_default_assets
    • IndexGeneratorDisplayField
      • IndexGeneratorDisplayField.name
      • IndexGeneratorDisplayField.source
      • IndexGeneratorDisplayField.fallback
      • IndexGeneratorDisplayField.type
      • IndexGeneratorDisplayField.label
      • IndexGeneratorDisplayField.searchable
      • IndexGeneratorDisplayField.format
      • IndexGeneratorDisplayField.mapping
      • IndexGeneratorDisplayField.filter_options
      • IndexGeneratorDisplayField.dynamic_options
      • IndexGeneratorDisplayField.display
      • IndexGeneratorDisplayField.inline_badge
      • IndexGeneratorDisplayField.badge_color
      • IndexGeneratorDisplayField.badge_style
      • IndexGeneratorDisplayField.badge_colors
      • IndexGeneratorDisplayField.badge_styles
      • IndexGeneratorDisplayField.true_label
      • IndexGeneratorDisplayField.false_label
      • IndexGeneratorDisplayField.tooltip_mapping
      • IndexGeneratorDisplayField.link_template
      • IndexGeneratorDisplayField.link_label
      • IndexGeneratorDisplayField.link_title
      • IndexGeneratorDisplayField.link_target
      • IndexGeneratorDisplayField.css_class
      • IndexGeneratorDisplayField.css_style
      • IndexGeneratorDisplayField.image_fields
      • IndexGeneratorDisplayField.model_config
    • IndexGeneratorFilterConfig
      • IndexGeneratorFilterConfig.field
      • IndexGeneratorFilterConfig.values
      • IndexGeneratorFilterConfig.operator
      • IndexGeneratorFilterConfig.model_config
    • IndexGeneratorPageConfig
      • IndexGeneratorPageConfig.title
      • IndexGeneratorPageConfig.description
      • IndexGeneratorPageConfig.items_per_page
      • IndexGeneratorPageConfig.model_config
    • IndexGeneratorViewConfig
      • IndexGeneratorViewConfig.type
      • IndexGeneratorViewConfig.template
      • IndexGeneratorViewConfig.default
      • IndexGeneratorViewConfig.model_config
    • IndexGeneratorConfig
      • IndexGeneratorConfig.enabled
      • IndexGeneratorConfig.template
      • IndexGeneratorConfig.page_config
      • IndexGeneratorConfig.filters
      • IndexGeneratorConfig.display_fields
      • IndexGeneratorConfig.views
      • IndexGeneratorConfig.output_pattern
      • IndexGeneratorConfig.model_config
    • GroupConfigWeb
      • GroupConfigWeb.group_by
      • GroupConfigWeb.data_source
      • GroupConfigWeb.navigation_entity
      • GroupConfigWeb.index_template
      • GroupConfigWeb.page_template
      • GroupConfigWeb.output_pattern
      • GroupConfigWeb.index_output_pattern
      • GroupConfigWeb.widgets
      • GroupConfigWeb.index_generator
      • GroupConfigWeb.model_config
    • IndexStructureConfig
      • IndexStructureConfig.total_key
      • IndexStructureConfig.list_key
      • IndexStructureConfig.include_total
      • IndexStructureConfig.model_config
    • JsonOptionsConfig
      • JsonOptionsConfig.indent
      • JsonOptionsConfig.ensure_ascii
      • JsonOptionsConfig.model_config
    • JsonExporterParams
      • JsonExporterParams.output_dir
      • JsonExporterParams.detail_output_pattern
      • JsonExporterParams.index_output_pattern
      • JsonExporterParams.index_structure
      • JsonExporterParams.json_options
      • JsonExporterParams.model_config
    • DetailApiConfig
      • DetailApiConfig.pass_through
      • DetailApiConfig.fields
      • DetailApiConfig.model_config
    • IndexApiFieldMapping
      • IndexApiFieldMapping.mapping
      • IndexApiFieldMapping.check_single_entry()
      • IndexApiFieldMapping.get_output_key()
      • IndexApiFieldMapping.get_config()
      • IndexApiFieldMapping.model_config
    • IndexApiConfig
      • IndexApiConfig.fields
      • IndexApiConfig.model_config
    • GroupConfigApi
      • GroupConfigApi.group_by
      • GroupConfigApi.data_source
      • GroupConfigApi.detail
      • GroupConfigApi.index
      • GroupConfigApi.json_options
      • GroupConfigApi.model_config
    • DwcMappingValue
      • DwcMappingValue.generator
      • DwcMappingValue.source
      • DwcMappingValue.params
      • DwcMappingValue.check_generator_or_source()
      • DwcMappingValue.model_config
    • DwcTransformerParams
      • DwcTransformerParams.model_config
      • DwcTransformerParams.occurrence_list_source
      • DwcTransformerParams.occurrence_table
      • DwcTransformerParams.taxonomy_entity
      • DwcTransformerParams.taxon_id_column
      • DwcTransformerParams.taxon_id_field
      • DwcTransformerParams.taxonomy_external_id_column
      • DwcTransformerParams.mapping
    • GroupConfigDwc
      • GroupConfigDwc.group_by
      • GroupConfigDwc.data_source
      • GroupConfigDwc.transformer_plugin
      • GroupConfigDwc.transformer_params
      • GroupConfigDwc.index
      • GroupConfigDwc.json_options
      • GroupConfigDwc.model_config
    • TargetConfig
      • TargetConfig.name
      • TargetConfig.enabled
      • TargetConfig.exporter
      • TargetConfig.params
      • TargetConfig.static_pages
      • TargetConfig.groups
      • TargetConfig.check_exporter_specific_fields()
      • TargetConfig.model_config
    • ExportConfig
      • ExportConfig.exports
      • ExportConfig.model_config
  • niamoto.core.plugins.plugin_loader module
    • PluginInfo
      • PluginInfo.name
      • PluginInfo.plugin_class
      • PluginInfo.scope
      • PluginInfo.path
      • PluginInfo.priority
      • PluginInfo.module_name
    • is_plugin_class()
    • PluginLoader
      • PluginLoader.load_plugins_with_cascade()
      • PluginLoader.get_plugin_info()
      • PluginLoader.get_plugin_details()
      • PluginLoader.reload_plugin()
      • PluginLoader.unload_plugin()
      • PluginLoader.discover_plugins()
      • PluginLoader.register_plugin()
      • PluginLoader.load_plugin()
  • niamoto.core.plugins.registry module
    • PluginRegistry
      • PluginRegistry.register_plugin()
      • PluginRegistry.get_plugin()
      • PluginRegistry.get_plugins_by_type()
      • PluginRegistry.get_plugin_metadata()
      • PluginRegistry.list_plugins()
      • PluginRegistry.clear()
      • PluginRegistry.has_plugin()
      • PluginRegistry.remove_plugin()
  • Module contents
• niamoto.core.services package
  • Submodules
  • niamoto.core.services.exporter module
    • ExporterService
      • ExporterService.get_export_targets()
      • ExporterService.run_export()
  • niamoto.core.services.importer module
    • ImporterService
      • ImporterService.close()
      • ImporterService.import_reference()
      • ImporterService.import_dataset()
      • ImporterService.import_all()
  • niamoto.core.services.transformer module
    • TransformerService
      • TransformerService.for_preview()
      • TransformerService.transform_single_widget()
      • TransformerService.transform_data()
      • TransformerService.validate_configuration()
  • Module contents

Module contents