niamoto.core.plugins.exporters package¶
Submodules¶
niamoto.core.plugins.exporters.dwc_archive_exporter module¶
niamoto.core.plugins.exporters.html_page_exporter module¶
Exporter plugin responsible for generating a static HTML website.
This exporter uses Jinja2 for templating and orchestrates the rendering of: - Static pages (e.g., index.html, about.html). - Index pages for data groups (e.g., list of taxa, list of plots). - Detail pages for individual items within groups (e.g., details for a specific taxon).
It leverages WidgetPlugins to render specific data visualizations (charts, maps, etc.) within the detail pages.
- class niamoto.core.plugins.exporters.html_page_exporter.HtmlPageExporter(db, registry=None)¶
Bases:
ExporterPluginGenerates a static HTML website based on the export configuration.
- Parameters:
db (Database)
- param_schema¶
alias of
HtmlExporterParams
- export(target_config, repository, group_filter=None)¶
Executes the HTML export process.
Supports multi-language generation when site.languages is configured with multiple languages. In that case, generates separate directories for each language (e.g., /fr/, /en/) and a redirect page at the root.
- Parameters:
target_config (TargetConfig) – The validated configuration for this HTML export target.
repository (Database) – The Database instance to fetch data from.
group_filter (str | None) – Optional filter to apply to the groups.
- Return type:
None