Ligare.web.scaffolding.scaffolder

Libraries used by Ligare.web.scaffolding.

Classes

Operation(name, **kwargs)
ScaffoldConfig(output_directory, application)
ScaffoldEndpoint(operation[, hostname])
ScaffoldModule(module_name)
Scaffolder(config, log)

class Ligare.web.scaffolding.scaffolder.Operation(name, **kwargs)

__init__(name, **kwargs)

module_name: str

raw_name: str

url_path_name: str

class Ligare.web.scaffolding.scaffolder.ScaffoldConfig(output_directory, application, template_type=None, modules=None, module=<factory>, endpoints=None, mode='create')

__init__(output_directory, application, template_type=None, modules=None, module=<factory>, endpoints=None, mode='create')

application: Operation

endpoints: list[ScaffoldEndpoint] | None = None

mode: str = 'create'

module: dict[str, Any]

modules: list[ScaffoldModule] | None = None

output_directory: str

template_type: Optional[Literal['basic', 'openapi']] = None

class Ligare.web.scaffolding.scaffolder.ScaffoldEndpoint(operation, hostname='http://localhost:5000')

__init__(operation, hostname='http://localhost:5000')

hostname: str = 'http://localhost:5000'

operation: Operation

class Ligare.web.scaffolding.scaffolder.ScaffoldModule(module_name)

__init__(module_name)

module_name: str

final class Ligare.web.scaffolding.scaffolder.Scaffolder(config, log)

MODULE_TEMPLATE_DIRECTORY = PosixPath('scaffolding/templates/optional/{{application.module_name}}/modules')

__init__(config, log)

render_module_template(module, module_template_directory, overwrite_existing_files=True)

scaffold()