betty.extension.demo package¶

Module contents¶

Provide demonstration site functionality.

final class betty.extension.demo.Demo[source]¶

Bases: Extension, Loader

Provide demonstration site functionality.

Parameters:

project (betty.project.Project)
args (typing.Any)
kwargs (typing.Any)

classmethod depends_on() → set[PluginId][source]¶

The extensions this one depends on, and comes after.

Return type:: set[str]

async load() → None[source]¶

Load ancestry data.

Return type:: None

classmethod plugin_id() → str[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.

Return type:: str

classmethod plugin_label() → betty.locale.localizable.Localizable[source]¶

Get the human-readable short plugin label.

Return type:: betty.locale.localizable.Localizable

final class betty.extension.demo.DemoServer[source]¶

Bases: Server

Serve the Betty demonstration site.

Parameters:: app (betty.app.App)

__init__(app: betty.app.App)[source]¶

Parameters:: app (betty.app.App)

property public_url: str¶: The server’s public URL.

async start() → None[source]¶

Start the server.

Return type:: None

async stop() → None[source]¶

Stop the server.

Return type:: None

betty.extension.demo.demo_project(app: betty.app.App) → collections.abc.AsyncIterator[betty.project.Project][source]¶

Create a new demonstration project.

Parameters:: app (betty.app.App)
Return type:: collections.abc.AsyncIterator[betty.project.Project]