betty.project.extension package¶
Subpackages¶
- betty.project.extension.cotton_candy package
- Submodules
- betty.project.extension.cotton_candy.config module
CottonCandyConfiguration
CottonCandyConfiguration.DEFAULT_LINK_ACTIVE_COLOR
CottonCandyConfiguration.DEFAULT_LINK_INACTIVE_COLOR
CottonCandyConfiguration.DEFAULT_PRIMARY_ACTIVE_COLOR
CottonCandyConfiguration.DEFAULT_PRIMARY_INACTIVE_COLOR
CottonCandyConfiguration.__init__()
CottonCandyConfiguration.dump()
CottonCandyConfiguration.featured_entities
CottonCandyConfiguration.link_active_color
CottonCandyConfiguration.link_inactive_color
CottonCandyConfiguration.load()
CottonCandyConfiguration.primary_active_color
CottonCandyConfiguration.primary_inactive_color
- betty.project.extension.cotton_candy.config module
- Module contents
CottonCandy
CottonCandy.__init__()
CottonCandy.__new__()
CottonCandy.assets_directory_path()
CottonCandy.bootstrap()
CottonCandy.comes_after()
CottonCandy.depends_on()
CottonCandy.filters
CottonCandy.new_default_configuration()
CottonCandy.new_for_project()
CottonCandy.public_css_paths
CottonCandy.register_event_handlers()
CottonCandy.webpack_entry_point_cache_keys()
CottonCandy.webpack_entry_point_directory_path()
- Submodules
- betty.project.extension.demo package
- betty.project.extension.deriver package
- betty.project.extension.gramps package
- betty.project.extension.http_api_doc package
- betty.project.extension.maps package
- betty.project.extension.privatizer package
- betty.project.extension.raspberry_mint package
- Submodules
- betty.project.extension.raspberry_mint.config module
RaspberryMintConfiguration
RaspberryMintConfiguration.DEFAULT_PRIMARY_COLOR
RaspberryMintConfiguration.DEFAULT_SECONDARY_COLOR
RaspberryMintConfiguration.DEFAULT_TERTIARY_COLOR
RaspberryMintConfiguration.__init__()
RaspberryMintConfiguration.dump()
RaspberryMintConfiguration.featured_entities
RaspberryMintConfiguration.load()
RaspberryMintConfiguration.primary_color
RaspberryMintConfiguration.secondary_color
RaspberryMintConfiguration.tertiary_color
- betty.project.extension.raspberry_mint.config module
- Module contents
RaspberryMint
RaspberryMint.__init__()
RaspberryMint.assets_directory_path()
RaspberryMint.bootstrap()
RaspberryMint.comes_after()
RaspberryMint.depends_on()
RaspberryMint.filters
RaspberryMint.new_default_configuration()
RaspberryMint.new_for_project()
RaspberryMint.public_css_paths
RaspberryMint.register_event_handlers()
RaspberryMint.webpack_entry_point_cache_keys()
RaspberryMint.webpack_entry_point_directory_path()
- Submodules
- betty.project.extension.trees package
- betty.project.extension.webpack package
- betty.project.extension.wikipedia package
Module contents¶
Provide Betty’s extension API.
- class betty.project.extension.ConfigurableExtension[source]¶
Bases:
DefaultConfigurable
[_ConfigurationT
],Extension
,Generic
[_ConfigurationT
]A configurable extension.
- class betty.project.extension.Dependencies[source]¶
Bases:
AllRequirements
Check a dependent’s dependency requirements.
- __init__(dependent: type[Extension], extension_id_to_type_mapping: PluginIdToTypeMapping[Extension], dependency_requirements: Sequence[Requirement])[source]¶
This is private. It MUST NOT be used anywhere outside its containing scope.
- summary() Localizable [source]¶
Get the requirement’s human-readable summary.
- betty.project.extension.EXTENSION_REPOSITORY: PluginRepository[Extension] = <betty.plugin.entry_point.EntryPointPluginRepository object>¶
The project extension plugin repository.
Read more about Extension plugins.
- class betty.project.extension.Extension[source]¶
Bases:
OrderedPlugin
[Extension
],DependentPlugin
[Extension
],CoreComponent
,ProjectDependentFactory
Integrate optional functionality with Betty :py:class:`betty.project.Project`s.
Read more about Extension plugins.
To test your own subclasses, use
betty.test_utils.project.extension.ExtensionTestBase
.- classmethod assets_directory_path() Path | None [source]¶
Return the path on disk where the extension’s assets are located.
This may be anywhere in your Python package.
- async classmethod new_for_project(project: Project) Self [source]¶
Create a new instance using the given project.
- register_event_handlers(registry: EventHandlerRegistry) None [source]¶
Register event handlers with the project.
- async classmethod requirement() Requirement [source]¶
Define the requirement for this extension to be enabled.
This defaults to the extension’s dependencies.