mini_arcade.modules.system_lab_scaffold.processors ================================================== .. py:module:: mini_arcade.modules.system_lab_scaffold.processors .. autoapi-nested-parse:: Processor for scaffolding minimal reusable system lab experiments. Classes ------- .. autoapisummary:: mini_arcade.modules.system_lab_scaffold.processors.SystemLabScaffoldSpec mini_arcade.modules.system_lab_scaffold.processors.SystemLabScaffoldProcessor Module Contents --------------- .. py:class:: SystemLabScaffoldSpec Specification for generating a minimal system lab scaffold. .. py:attribute:: lab_id :type: str .. py:attribute:: case_name :type: str .. py:attribute:: title :type: str .. py:attribute:: target_dir :type: pathlib.Path .. py:attribute:: class_name :type: str .. py:class:: SystemLabScaffoldProcessor(**kwargs) Bases: :py:obj:`mini_arcade.cli.base_command_processor.BaseCommandProcessor` Processor for creating minimal reusable system lab experiments. .. py:attribute:: lab_id :type: str .. py:attribute:: case_name :type: str | None :value: None .. py:attribute:: title :type: str | None :value: None .. py:attribute:: destination :type: str :value: 'experiments' .. py:attribute:: force :type: bool :value: False .. py:attribute:: dry_run :type: bool :value: False .. py:method:: run() -> int Run the command processor. :return: Optional result of the command execution. :rtype: Optional[Any]