mini_arcade.modules.system_lab_scaffold ======================================= .. py:module:: mini_arcade.modules.system_lab_scaffold .. autoapi-nested-parse:: Scaffold helpers for minimal reusable system lab experiments. Submodules ---------- .. toctree:: :maxdepth: 1 /autoapi/mini_arcade/modules/system_lab_scaffold/commands/index /autoapi/mini_arcade/modules/system_lab_scaffold/processors/index Classes ------- .. autoapisummary:: mini_arcade.modules.system_lab_scaffold.ScaffoldSystemLabCommand Package Contents ---------------- .. py:class:: ScaffoldSystemLabCommand Bases: :py:obj:`mini_arcade.cli.base_command.BaseCommand` Base class for all commands. Registration is done via the implementation decorator: @CommandRegistry.implementation("build") class Build(BaseCommand): ... or: from .command_registry import CommandRegistry @CommandRegistry.implementation("build") class Build(BaseCommand): ... Subclasses should implement the execute(...) method as the main entrypoint. :ivar name: Optional[str]: Command name (for registry); defaults to class name lowercased. :ivar aliases: Tuple[str, ...]: Optional command aliases. :ivar summary: Optional[str]: Short description of the command. :ivar epilog: Optional[str]: Additional help text for the command. :ivar args: Optional[List[ArgumentType]]: List of command arguments. :ivar abstract: bool: If True, the command is not registered (base class for shared logic); defaults to False. :ivar processor: Optional[BaseCommandProcessor]: The processor associated with this command. .. py:attribute:: name :value: 'scaffold-system-lab' .. py:attribute:: aliases :value: ('new-system-lab', 'scaffold-lab', 'new-lab') .. py:attribute:: args .. py:attribute:: __doc__ :value: Multiline-String .. raw:: html
Show Value .. code-block:: python """ Scaffold a minimal reusable system lab experiment. Usage: mini-arcade scaffold-system-lab --lab-id sparks_lab mini-arcade scaffold-system-lab --lab-id sparks-lab --destination C:\dev\mini-arcade\experiments mini-arcade scaffold-system-lab --lab-id sparks_lab --case-name spark_stats --dry-run """ .. raw:: html