betty.extension.nginx package

Submodules

• betty.extension.nginx.artifact module
  • generate_configuration_file()
  • generate_dockerfile_file()
• betty.extension.nginx.config module
  • NginxConfiguration
    • NginxConfiguration.__init__()
    • NginxConfiguration.dump()
    • NginxConfiguration.https
    • NginxConfiguration.load()
    • NginxConfiguration.update()
    • NginxConfiguration.www_directory_path
• betty.extension.nginx.docker module
  • Container
    • Container.__init__()
    • Container.ip
    • Container.start()
    • Container.stop()
• betty.extension.nginx.serve module
  • DockerizedNginxServer
    • DockerizedNginxServer.__init__()
    • DockerizedNginxServer.is_available()
    • DockerizedNginxServer.public_url
    • DockerizedNginxServer.start()
    • DockerizedNginxServer.stop()

Module contents

Integrate Betty with nginx.

final class betty.extension.nginx.Nginx

Bases: ConfigurableExtension[NginxConfiguration], Generator

Integrate Betty with nginx (and Docker).

Parameters:

• args (typing.Any)

• configuration (typing.Optional[typing.TypeVar(_ConfigurationT, bound= betty.config.Configuration)])

• kwargs (typing.Any)

classmethod assets_directory_path() → pathlib.Path | None

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() → betty.extension.nginx.config.NginxConfiguration

Get this extension’s default configuration.

Return type:

betty.extension.nginx.config.NginxConfiguration

async generate(job_context: betty.generate.GenerationContext) → None

Generate (part of) a project’s site.

Parameters:

job_context (betty.generate.GenerationContext)

Return type:

None

property https: bool

Whether the nginx server should use HTTPS.

classmethod plugin_description() → betty.locale.localizable.Localizable

Get the human-readable long plugin description.

Return type:

betty.locale.localizable.Localizable

classmethod plugin_id() → str

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

Get the human-readable short plugin label.

Return type:

betty.locale.localizable.Localizable

property www_directory_path: str

The nginx server’s public web root directory path.