betty.extension.cotton_candy package

Submodules

Module contents

Provide Betty’s default theme.

final class betty.extension.cotton_candy.CottonCandy[source]

Bases: Theme, CssProvider, ConfigurableExtension[CottonCandyConfiguration], Jinja2Provider, WebpackEntryPointProvider

Provide Betty’s default front-end theme.

classmethod assets_directory_path() Path[source]

Return the path on disk where the extension’s assets are located.

This may be anywhere in your Python package.

classmethod comes_after() set[MachineName][source]

The extensions that this one comes after.

The other extensions may or may not be enabled.

classmethod default_configuration() CottonCandyConfiguration[source]

Get this extension’s default configuration.

classmethod depends_on() set[MachineName][source]

The extensions this one depends on, and comes after.

property filters: dict[str, Callable[[...], Any]]

Jinja2 filters provided by this extension.

Keys are filter names, and values are the filters themselves.

property globals: dict[str, Any]

Jinja2 globals provided by this extension.

Keys are the globals’ names, and values are the globals’ values.

The path to the logo file.

classmethod plugin_description() Localizable[source]

Get the human-readable long plugin description.

classmethod plugin_id() MachineName[source]

Get the plugin ID.

IDs are unique per plugin type:

  • A plugin repository MUST at most have a single plugin for any ID.

  • Different plugin repositories MAY each have a plugin with the same ID.

classmethod plugin_label() Localizable[source]

Get the human-readable short plugin label.

property public_css_paths: list[str]

The public URL paths to the CSS files to include in each HTML page.

register_event_handlers(registry: EventHandlerRegistry) None[source]

Register event handlers with the project.

webpack_entry_point_cache_keys() Sequence[str][source]

Get the keys that make a Webpack build for this provider unique.

Providers that can be cached regardless may return ().

classmethod webpack_entry_point_directory_path() Path[source]

Get the path to the directory with the entry point assets.

The directory must include at least a package.json and main.ts.

betty.extension.cotton_candy.associated_file_references(has_file_references: HasFileReferences) Iterable[FileReference][source]

Get the associated file references for an entity that has file references.

betty.extension.cotton_candy.person_descendant_families(person: Person) Iterable[tuple[Sequence[Person], Sequence[Person]]][source]

Gather a person’s families they are a parent in.

betty.extension.cotton_candy.person_timeline_events(person: Person, lifetime_threshold: int) Iterable[Event][source]

Gather all events for a person’s timeline.