jobflow_remote.cli.project module

jobflow_remote.cli.project.check(jobstore: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f44e9550>] = False, queue: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f44e9610>] = False, worker: ~typing.Annotated[str, <typer.models.OptionInfo object at 0x7f48f44e93d0>] = None, print_errors: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f44e9710>] = False, full: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f44e9810>] = False) → None

Check that the connection to the different elements of the projects are working.

jobflow_remote.cli.project.current_project(ctx: ~typer.models.Context, print_tree: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a32050>] = False) → None

Print the list of the project currently selected.

jobflow_remote.cli.project.generate(name: ~typing.Annotated[str, <typer.models.ArgumentInfo object at 0x7f48f44e9150>], file_format: ~jobflow_remote.cli.utils.Annotated[~jobflow_remote.cli.utils.SerializeFileFormat, <typer.models.OptionInfo object at 0x7f48f4a198d0>] = SerializeFileFormat.YAML, full: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f44e91d0>] = False) → None

Generate a project configuration file with dummy elements to be edited manually.

jobflow_remote.cli.project.list_exec_config(verbosity: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f48f4a18550>] = 0) → None

The list of defined Execution configurations

jobflow_remote.cli.project.list_projects(warn: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f44e8cd0>] = False) → None

List of available projects.

jobflow_remote.cli.project.list_worker(verbosity: ~typing.Annotated[int, <typer.models.OptionInfo object at 0x7f48f4a18550>] = 0) → None

The list of defined workers

jobflow_remote.cli.project.remove(name: ~typing.Annotated[str, <typer.models.ArgumentInfo object at 0x7f48f44e99d0>], keep_folders: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f44e9a10>] = False, yes_all: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a194d0>] = False, force_deprecated: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a193d0>] = False) → None

Remove a project from the projects’ folder, including the related folders.

jobflow_remote.cli.project.replace(old_string: ~typing.Annotated[str, <typer.models.ArgumentInfo object at 0x7f48f44ea610>], new_string: ~typing.Annotated[str, <typer.models.ArgumentInfo object at 0x7f48f44ea690>], all_projects: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f44ea510>] = False, yes_all: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a194d0>] = False, force_deprecated: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f4a193d0>] = False, no_backup: ~typing.Annotated[bool, <typer.models.OptionInfo object at 0x7f48f44eb990>] = False) → None

Replace a string in one or more project files.

This command performs a text replacement in the YAML project files, replacing all instances of old_string with new_string. By default, creates a backup of the original file.