References

Optimus is mainly a commandeline tool but it relies on a core API that may be used programatically from another application.

Modules

• Exceptions
• OptimusBaseException
• DestinationExists
• SettingsImportError
• TemplateImportError
• TemplateSettingsInvalidError
• InvalidLangageIdentifier
• InvalidSettings
• ViewImproperlyConfigured
• ServerConfigurationError
• InvalidHostname
• DataProcessError
• Logging
• set_loggers_level()
• init_logger()
• Project settings
• Settings model
• SettingsModel
  • SettingsModel._excluded_names
  • SettingsModel._required_settings
  • SettingsModel.validate_name()
  • SettingsModel.check()
  • SettingsModel._default_jinja()
  • SettingsModel._default_watchdog()
  • SettingsModel._default_webassets()
  • SettingsModel._default_babel()
  • SettingsModel.apply_defaults()
  • SettingsModel.load_from_kwargs()
  • SettingsModel.load_from_module()
• Module loader helpers
• import_project_module()
• import_settings_module()
• import_pages_module()
• load_settings()
• import_settings()
• Assets registry
• AssetRegistry
  • AssetRegistry.map_dest_to_bundle
  • AssetRegistry.logger
  • AssetRegistry.add_bundle()
• register_assets()
• RCSSMin
• Watcher handlers
• BaseHandler
  • BaseHandler.get_relative_template_path()
  • BaseHandler.get_relative_asset_path()
  • BaseHandler.get_relative_data_path()
• TemplatesWatchEventHandler
  • TemplatesWatchEventHandler.settings
  • TemplatesWatchEventHandler.builder
  • TemplatesWatchEventHandler.logger
  • TemplatesWatchEventHandler.build_for_item()
  • TemplatesWatchEventHandler.on_moved()
  • TemplatesWatchEventHandler.on_created()
  • TemplatesWatchEventHandler.on_modified()
• AssetsWatchEventHandler
  • AssetsWatchEventHandler.settings
  • AssetsWatchEventHandler.assets_env
  • AssetsWatchEventHandler.builder
  • AssetsWatchEventHandler.logger
  • AssetsWatchEventHandler.build_for_item()
  • AssetsWatchEventHandler.on_moved()
  • AssetsWatchEventHandler.on_created()
  • AssetsWatchEventHandler.on_modified()
• Page building and views
• PageRegistry
  • PageRegistry.templates
  • PageRegistry.destinations_pages_index
  • PageRegistry.logger
  • PageRegistry.add_page()
  • PageRegistry.add_data()
  • PageRegistry.get_pages_from_template()
  • PageRegistry.get_pages_from_data()
  • PageRegistry.get_all_destinations()
  • PageRegistry.get_all_pages()
• PageBuilder
  • PageBuilder.logger
  • PageBuilder.settings
  • PageBuilder.jinja_env
  • PageBuilder.assets_env
  • PageBuilder.internationalized
  • PageBuilder.translations
  • PageBuilder.registry
  • PageBuilder.dry_run
  • PageBuilder.get_environnement()
  • PageBuilder.serialize_settings()
  • PageBuilder.get_globals()
  • PageBuilder.get_translation_for_item()
  • PageBuilder.scan_item()
  • PageBuilder.scan_bulk()
  • PageBuilder.build_item()
  • PageBuilder.build_bulk()
• PageViewBase
  • PageViewBase.title
  • PageViewBase.destination
  • PageViewBase.lang
  • PageViewBase.datas
  • PageViewBase.context
  • PageViewBase.logger
  • PageViewBase._used_templates
  • PageViewBase.__settings
  • PageViewBase.validate()
  • PageViewBase.settings
  • PageViewBase.get_title()
  • PageViewBase.get_lang()
  • PageViewBase.get_destination()
  • PageViewBase.get_datas()
  • PageViewBase.get_relative_position()
  • PageViewBase.get_context()
  • PageViewBase.render()
  • PageViewBase.introspect()
• PageTemplateView
  • PageTemplateView.template_name
  • PageTemplateView.get_template_name()
  • PageTemplateView._recurse_template_search()
  • PageTemplateView.get_context()
  • PageTemplateView.introspect()
  • PageTemplateView.render()
• Internationalization and localization
• Langage base object
• LangBase
  • LangBase.label
  • LangBase.code
  • LangBase.alt_code
  • LangBase.external_code
  • LangBase.split_code()
• I18n management
• I18NManager
  • I18NManager.catalog_name
  • I18NManager.catalog_path
  • I18NManager.header_comment
  • I18NManager.settings
  • I18NManager.logger
  • I18NManager.get_template_path()
  • I18NManager.get_catalog_dir()
  • I18NManager.get_po_filepath()
  • I18NManager.get_mo_filepath()
  • I18NManager.check_locales_dir()
  • I18NManager.check_template_path()
  • I18NManager.check_catalog_path()
  • I18NManager.parse_languages()
  • I18NManager.init_locales_dir()
  • I18NManager.build_pot()
  • I18NManager.pot
  • I18NManager.safe_write_po()
  • I18NManager.clone_pot()
  • I18NManager.init_catalogs()
  • I18NManager.update_catalogs()
  • I18NManager.compile_catalogs()
• Interfaces
• starter_interface()
• builder_interface()
• watcher_interface()
• po_interface()
• server_interface()