betty.extension.trees package

Module contents

Provide interactive family trees by integrating Betty with Cytoscape.js.

class betty.extension.trees.Trees[source]

Bases: UserFacingExtension, WebpackEntryPointProvider

Provide interactive family trees for use in web pages.

Parameters:
classmethod assets_directory_path() pathlib._local.Path[source]

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

This may be anywhere in your Python package.

Return type:

pathlib._local.Path

classmethod depends_on() set[type[betty.app.extension.Extension]][source]

The extensions this one depends on, and comes after.

Return type:

set[type[betty.app.extension.Extension]]

classmethod description() betty.locale.Str[source]

Get the human-readable extension description.

Return type:

betty.locale.Str

classmethod label() betty.locale.Str[source]

Get the human-readable extension label.

Return type:

betty.locale.Str

classmethod name() str[source]

The machine name.

Return type:

str

webpack_entry_point_cache_keys() collections.abc.Sequence[str][source]

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

Providers that can be cached regardless may return ().

Return type:

collections.abc.Sequence[str]

classmethod webpack_entry_point_directory_path() pathlib._local.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.

Return type:

pathlib._local.Path