betty.extension.nginx package

Submodules

Module contents

Integrate Betty with nginx.

class betty.extension.nginx.Nginx(*args, configuration=None, **kwargs)[source]

Bases: ConfigurableExtension[NginxConfiguration], Generator, ServerProvider, GuiBuilder

Parameters:
*args

configuration=None

**kwargs

classmethod assets_directory_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.Path | None

classmethod default_configuration()[source]
Return type:

betty.extension.nginx.NginxConfiguration

classmethod description()[source]
Return type:

betty.locale.Str

async generate(job_context)[source]
Parameters:
job_context

Return type:

None

gui_build()[source]
Return type:

PyQt6.QtWidgets.QWidget

property https : bool
classmethod label()[source]
Return type:

betty.locale.Str

property servers : Sequence[Server]
property www_directory_path : str
class betty.extension.nginx.NginxConfiguration(*, www_directory_path=None, https=None)[source]

Bases: Configuration

Parameters:
www_directory_path=None

https=None

dump()[source]

Dump this instance to a portable format.

Return type:

typing.Union[bool, int, float, str, None, typing.Sequence[typing.Union[bool, int, float, str, None, typing.Sequence[Dump], typing.Mapping[str, Dump]]], typing.Mapping[str, typing.Union[bool, int, float, str, None, typing.Sequence[Dump], typing.Mapping[str, Dump]]], type[betty.serde.dump.Void]]

property https : bool | None
classmethod load(dump, configuration=None)[source]

Load dumped configuration into a new configuration instance.

Parameters:
dump

configuration=None

Return type:

typing.Self

update(other)[source]
Parameters:
other

Return type:

None

property www_directory_path : str | None