thestage 0.6.4__py3-none-any.whl → 0.6.6__py3-none-any.whl

thestage/__init__.py

@@ -1,3 +1,3 @@
 from . import *
 __app_name__ = "thestage"
-__version__ = "0.6.3"
+__version__ = "0.6.6"

thestage/color_scheme/color_scheme.py

@@ -5,3 +5,4 @@ class ColorScheme(str, Enum):
     GIT_HEADLESS = "orange_red1"
     WARNING = "orange_red1"
     USEFUL_INFO = "deep_sky_blue1"
+    SUCCESS = "green"

thestage/controllers/base_controller.py

@@ -27,8 +27,9 @@ def version():
 
 @app.command(name="connect", no_args_is_help=True, help=__("Connect to server instance or container or task"), **get_command_metadata(CliCommand.CONNECT))
 def connect(
-        uid: Optional[str] = typer.Argument(
-            help=__("Unique ID of server instance or container or task ID"), ),
+        entity_identifier: Optional[str] = typer.Argument(
+            help="Name or ID of server instance or container or task",
+        ),
         username: Optional[str] = typer.Option(
             None,
             '--username',
@@ -57,7 +58,7 @@ def connect(
     connect_service: ConnectService = service_factory.get_connect_service()
 
     connect_service.connect_to_entity(
-        uid=uid,
+        input_entity_identifier=entity_identifier,
         username=username,
         private_key_path=private_ssh_key_path
     )

thestage/controllers/config_controller.py

@@ -85,13 +85,20 @@ def config_clear():
 @app.command(name='upload-ssh-key', no_args_is_help=True, help=__("Send your public SSH key to the platform and / or rented server instance"), **get_command_metadata(CliCommand.CONFIG_UPLOAD_SSH_KEY))
 def upload_ssh_key(
         ssh_public_key: str = typer.Argument(
-            help=__("Path to your public SSH key file or your public SSH key contents"),
+            help=__("Path to your public SSH key file or your public SSH key contents. OpenSSH key format is required."),
+        ),
+        instance_rented_public_id: str = typer.Option(
+            None,
+            "--instance-rented-id",
+            "-rid",
+            help=__("ID of your rented instance to add the key to (optional)"),
+            is_eager=False,
         ),
         instance_rented_slug: str = typer.Option(
             None,
-            "--instance-uid",
-            "-uid",
-            help=__("Unique ID of your rented instance to add the key to (optional)"),
+            "--instance-rented-name",
+            "-rn",
+            help=__("Name of your rented instance to add the key to (optional)"),
             is_eager=False,
         )
 ):
@@ -99,6 +106,10 @@ def upload_ssh_key(
     app_logger.info(f'Running {command_name} from {get_current_directory()}')
     check_command_permission(command_name)
 
+    if sum(v is not None for v in [instance_rented_public_id, instance_rented_slug]) > 1:
+        typer.echo("Please provide a single identifier for rented instance - ID or name.")
+        raise typer.Exit(1)
+
     service_factory = ServiceFactory()
     connect_service: ConnectService = service_factory.get_connect_service()
 
@@ -131,6 +142,7 @@ def upload_ssh_key(
 
     connect_service.upload_ssh_key(
         public_key_contents=ssh_key_contents,
+        instance_public_id=instance_rented_public_id,
         instance_slug=instance_rented_slug,
     )
 

thestage/controllers/container_controller.py

@@ -35,11 +35,18 @@ def list_containers(
             help=__("Set starting page for displaying output"),
             is_eager=False,
         ),
-        project_uid: str = typer.Option(
+        project_public_id: str = typer.Option(
             None,
-            '--project-uid',
-            '-puid',
-            help=__("Filter containers by project unique ID"),
+            '--project-id',
+            '-pid',
+            help=__("Filter containers by project, using the project's ID"),
+            is_eager=False,
+        ),
+        project_slug: str = typer.Option(
+            None,
+            '--project-name',
+            '-pn',
+            help=__("Filter containers by project, using the project's name"),
             is_eager=False,
         ),
         statuses: List[str] = typer.Option(
@@ -54,12 +61,17 @@ def list_containers(
     app_logger.info(f'Running {command_name}')
     check_command_permission(command_name)
 
+    if sum(v is not None for v in [project_public_id, project_slug]) > 1:
+        typer.echo("Please provide a single identifier for project - ID or name.")
+        raise typer.Exit(1)
+
     service_factory = validate_config_and_get_service_factory()
     container_service: ContainerService = service_factory.get_container_service()
     container_service.print_container_list(
         row=row,
         page=page,
-        project_uid=project_uid,
+        project_public_id=project_public_id,
+        project_slug=project_slug,
         statuses=statuses,
     )
 
@@ -69,45 +81,61 @@ def list_containers(
 
 @app.command(name="info", no_args_is_help=True, help=__("Get container info"), **get_command_metadata(CliCommand.CONTAINER_INFO))
 def container_info(
-        container_uid: Optional[str] = typer.Argument(hidden=False, help=__("Container unique ID")),
+        container_public_id: str = typer.Option(
+            None,
+            '--container-id',
+            '-cid',
+            help=__("Container ID"),
+            is_eager=False,
+        ),
+        container_slug: str = typer.Option(
+            None,
+            '--container-name',
+            '-cn',
+            help=__("Container name"),
+            is_eager=False,
+        ),
 ):
     command_name = CliCommand.CONTAINER_INFO
     app_logger.info(f'Running {command_name} from {get_current_directory()}')
     check_command_permission(command_name)
 
-    if not container_uid:
-        typer.echo(__('Container unique ID is required'))
+    if sum(v is not None for v in [container_public_id, container_slug]) != 1:
+        typer.echo("Please provide a single identifier for container - ID or name.")
         raise typer.Exit(1)
 
     service_factory = validate_config_and_get_service_factory()
     container_service: ContainerService = service_factory.get_container_service()
 
     container: Optional[DockerContainerDto] = container_service.get_container(
-        container_slug=container_uid,
+        container_public_id=container_public_id,
+        container_slug=container_slug,
     )
 
     if not container:
-        typer.echo(__("Container not found: %container_item%", {'container_item': str(container_uid) if container_uid else ''}))
+        typer.echo("Container not found")
         raise typer.Exit(1)
 
     typer.echo(__("STATUS: %status%", {'status': str(container.frontend_status.status_translation if container and container.frontend_status else 'UNKNOWN')}))
-    typer.echo(__("UNIQUE ID: %slug%", {'slug': str(container.slug)}))
-    typer.echo(__("TITLE: %title%", {'title': str(container.title)}))
+    typer.echo(__("ID: %slug%", {'slug': str(container.public_id)}))
+    typer.echo(__("NAME: %title%", {'title': str(container.slug)}))
     typer.echo(__("IMAGE: %image%", {'image': str(container.docker_image)}))
 
+    typer.echo(f"CONTAINER INSTANCE:")
+
     if container.instance_rented:
+        typer.echo(f"    TYPE: RENTED")
+        typer.echo(f"    ID: {container.instance_rented.public_id}")
+        typer.echo(f"    NAME: {container.instance_rented.slug}")
         typer.echo(
-            __("RENTED SERVER INSTANCE UNIQUE ID: %instance_slug%", {'instance_slug': str(container.instance_rented.slug)})
-        )
-        typer.echo(
-            __("RENTED SERVER INSTANCE STATUS: %instance_status%",
+            __("RENTED INSTANCE STATUS: %instance_status%",
                {'instance_status': str(container.instance_rented.frontend_status.status_translation if container.instance_rented.frontend_status else 'UNKNOWN')})
         )
 
     if container.selfhosted_instance:
-        typer.echo(
-            __("SELF-HOSTED INSTANCE UNIQUE ID: %instance_slug%", {'instance_slug': str(container.selfhosted_instance.slug)})
-        )
+        typer.echo(f"    TYPE: SELF-HOSTED")
+        typer.echo(f"    ID: {container.selfhosted_instance.public_id}")
+        typer.echo(f"    NAME: {container.selfhosted_instance.slug}")
         typer.echo(
             __("SELF-HOSTED INSTANCE STATUS: %instance_status%",
                {'instance_status': str(container.selfhosted_instance.frontend_status.status_translation if container.selfhosted_instance.frontend_status else 'UNKNOWN')})
@@ -129,7 +157,20 @@ def container_info(
 
 @app.command(name="connect", no_args_is_help=True, help=__("Connect to container"), **get_command_metadata(CliCommand.CONTAINER_CONNECT))
 def container_connect(
-        container_uid: Optional[str] = typer.Argument(help=__("Container unique ID"),),
+        container_public_id: str = typer.Option(
+            None,
+            '--container-id',
+            '-cid',
+            help=__("Container ID"),
+            is_eager=False,
+        ),
+        container_slug: str = typer.Option(
+            None,
+            '--container-name',
+            '-cn',
+            help=__("Container name"),
+            is_eager=False,
+        ),
         username: Optional[str] = typer.Option(
             None,
             '--username',
@@ -149,8 +190,8 @@ def container_connect(
     app_logger.info(f'Running {command_name} from {get_current_directory()}')
     check_command_permission(command_name)
 
-    if not container_uid:
-        typer.echo(__('Container unique ID is required'))
+    if sum(v is not None for v in [container_public_id, container_slug]) != 1:
+        typer.echo("Please provide a single identifier for container - ID or name.")
         raise typer.Exit(1)
 
     if private_ssh_key_path and not Path(private_ssh_key_path).is_file():
@@ -161,7 +202,8 @@ def container_connect(
     container_service: ContainerService = service_factory.get_container_service()
 
     container_service.connect_to_container(
-        container_uid=container_uid,
+        container_public_id=container_public_id,
+        container_slug=container_slug,
         username=username,
         input_ssh_key_path=private_ssh_key_path,
     )
@@ -173,7 +215,7 @@ def container_connect(
 @app.command(name="upload", no_args_is_help=True, help=__("Upload file to container"), **get_command_metadata(CliCommand.CONTAINER_UPLOAD))
 def upload_file(
         source_path: str = typer.Argument(help=__("Source file path"),),
-        destination: Optional[str] = typer.Argument(help=__("Destination directory path in container. Format: container_uid:/path/to/file"),),
+        destination: Optional[str] = typer.Argument(help=__("Destination directory path in container. Format: container_name:/path/to/file"),),
         username: Optional[str] = typer.Option(
             None,
             '--username',
@@ -189,14 +231,14 @@ def upload_file(
     container_args = re.match(r"^([\w\W]+?):([\w\W]+)$", destination)
 
     if container_args is None:
-        typer.echo(__('Container unique ID and source file path are required as the second argument'))
+        typer.echo(__('Container name and source file path are required as the second argument'))
         typer.echo(__('Example: container_uid:/path/to/file'))
         raise typer.Exit(1)
     container_slug = container_args.groups()[0]
     destination_path = container_args.groups()[1].rstrip("/")
 
     if not container_slug:
-        typer.echo(__('Container unique ID is required'))
+        typer.echo(__('Container name is required'))
         raise typer.Exit(1)
 
     service_factory = validate_config_and_get_service_factory()
@@ -211,7 +253,7 @@ def upload_file(
             container=container
         )
 
-        typer.echo(__("Uploading file(s) to container '%container-slug%'", {'container-slug': container_slug}))
+        typer.echo(f"Uploading file(s) to container '{container_slug}'")
 
         container_service.put_file_to_container(
             container=container,
@@ -229,7 +271,7 @@ def upload_file(
 
 @app.command(name="download", no_args_is_help=True, help=__("Download file from container"), **get_command_metadata(CliCommand.CONTAINER_DOWNLOAD))
 def download_file(
-        source_path: str = typer.Argument(help=__("Source file path in container. Format: container_uid:/path/to/file"),),
+        source_path: str = typer.Argument(help=__("Source file path in container. Format: container_name:/path/to/file"),),
         destination_path: str = typer.Argument(help=__("Destination directory path on local machine"),),
         username: Optional[str] = typer.Option(
             None,
@@ -246,14 +288,14 @@ def download_file(
     container_args = re.match(r"^([\w\W]+?):([\w\W]+)$", source_path)
 
     if container_args is None:
-        typer.echo(__('Container unique ID and source directory path are required as the first argument'))
+        typer.echo(__('Container name and source directory path are required as the first argument'))
         typer.echo(__('Example: container-uid:/path/to/file'))
         raise typer.Exit(1)
     container_slug = container_args.groups()[0]
     source_path = container_args.groups()[1]
 
     if not container_slug:
-        typer.echo(__('Container unique ID is required'))
+        typer.echo(__('Container name is required'))
         raise typer.Exit(1)
 
     service_factory = validate_config_and_get_service_factory()
@@ -268,7 +310,7 @@ def download_file(
             container=container
         )
 
-        typer.echo(__("Downloading files from container: '%container-slug%'", {'container-slug': container_slug}))
+        typer.echo(f"Downloading files from container: '{container_slug}'")
 
         container_service.get_file_from_container(
             container=container,
@@ -278,7 +320,7 @@ def download_file(
             copy_only_folder_contents=source_path.endswith("/"),
         )
     else:
-        typer.echo(__("Container not found: %container_item%", {'container_item': container_slug}))
+        typer.echo(f"Container not found: {container_slug}")
 
     app_logger.info(f'End download files from container')
     raise typer.Exit(0)
@@ -286,21 +328,35 @@ def download_file(
 
 @app.command(name="start", no_args_is_help=True, help=__("Start container"), **get_command_metadata(CliCommand.CONTAINER_START))
 def start_container(
-        container_uid: Optional[str] = typer.Argument(help=__("Container unique ID"), ),
+        container_public_id: str = typer.Option(
+            None,
+            '--container-id',
+            '-cid',
+            help=__("Container ID"),
+            is_eager=False,
+        ),
+        container_slug: str = typer.Option(
+            None,
+            '--container-name',
+            '-cn',
+            help=__("Container name"),
+            is_eager=False,
+        ),
 ):
     command_name = CliCommand.CONTAINER_START
     app_logger.info(f'Running {command_name} from {get_current_directory()}')
     check_command_permission(command_name)
 
-    if not container_uid:
-        typer.echo(__('Container unique ID is required'))
+    if sum(v is not None for v in [container_public_id, container_slug]) != 1:
+        typer.echo("Please provide a single identifier for container - ID or name.")
         raise typer.Exit(1)
 
     service_factory = validate_config_and_get_service_factory()
     container_service: ContainerService = service_factory.get_container_service()
 
     container_service.request_docker_container_action(
-        container_uid=container_uid,
+        container_public_id=container_public_id,
+        container_slug=container_slug,
         action=DockerContainerAction.START
     )
 
@@ -310,21 +366,35 @@ def start_container(
 
 @app.command(name="stop", no_args_is_help=True, help=__("Stop container"), **get_command_metadata(CliCommand.CONTAINER_STOP))
 def stop_container(
-        container_uid: Optional[str] = typer.Argument(help=__("Container unique ID"), ),
+        container_public_id: str = typer.Option(
+            None,
+            '--container-id',
+            '-cid',
+            help=__("Container ID"),
+            is_eager=False,
+        ),
+        container_slug: str = typer.Option(
+            None,
+            '--container-name',
+            '-cn',
+            help=__("Container name"),
+            is_eager=False,
+        ),
 ):
     command_name = CliCommand.CONTAINER_STOP
     app_logger.info(f'Running {command_name} from {get_current_directory()}')
     check_command_permission(command_name)
 
-    if not container_uid:
-        typer.echo(__('Container unique ID is required'))
+    if sum(v is not None for v in [container_public_id, container_slug]) != 1:
+        typer.echo("Please provide a single identifier for container - ID or name.")
         raise typer.Exit(1)
 
     service_factory = validate_config_and_get_service_factory()
     container_service: ContainerService = service_factory.get_container_service()
 
     container_service.request_docker_container_action(
-        container_uid=container_uid,
+        container_public_id=container_public_id,
+        container_slug=container_slug,
         action=DockerContainerAction.STOP
     )
 
@@ -334,21 +404,35 @@ def stop_container(
 
 @app.command(name="restart", no_args_is_help=True, help=__("Restart container"), **get_command_metadata(CliCommand.CONTAINER_RESTART))
 def restart_container(
-        container_uid: Optional[str] = typer.Argument(help=__("Container unique ID"), ),
+        container_public_id: str = typer.Option(
+            None,
+            '--container-id',
+            '-cid',
+            help=__("Container ID"),
+            is_eager=False,
+        ),
+        container_slug: str = typer.Option(
+            None,
+            '--container-name',
+            '-cn',
+            help=__("Container name"),
+            is_eager=False,
+        ),
 ):
     command_name = CliCommand.CONTAINER_RESTART
     app_logger.info(f'Running {command_name} from {get_current_directory()}')
     check_command_permission(command_name)
 
-    if not container_uid:
-        typer.echo(__('Container unique ID is required'))
+    if sum(v is not None for v in [container_public_id, container_slug]) != 1:
+        typer.echo("Please provide a single identifier for container - ID or name.")
         raise typer.Exit(1)
 
     service_factory = validate_config_and_get_service_factory()
     container_service: ContainerService = service_factory.get_container_service()
 
     container_service.request_docker_container_action(
-        container_uid=container_uid,
+        container_public_id=container_public_id,
+        container_slug=container_slug,
         action=DockerContainerAction.RESTART
     )
 
@@ -358,7 +442,20 @@ def restart_container(
 
 @app.command(name="logs", no_args_is_help=True, help=__("Stream real-time Docker container logs or view last logs for a container"), **get_command_metadata(CliCommand.CONTAINER_LOGS))
 def container_logs(
-        container_uid: Optional[str] = typer.Argument(help=__("Container unique id")),
+        container_public_id: str = typer.Option(
+            None,
+            '--container-id',
+            '-cid',
+            help=__("Container ID"),
+            is_eager=False,
+        ),
+        container_slug: str = typer.Option(
+            None,
+            '--container-name',
+            '-cn',
+            help=__("Container name"),
+            is_eager=False,
+        ),
         logs_number: Optional[int] = typer.Option(
             None,
             '--number',
@@ -371,8 +468,8 @@ def container_logs(
     app_logger.info(f'Running {command_name} from {get_current_directory()}')
     check_command_permission(command_name)
 
-    if not container_uid:
-        typer.echo(__('Container unique ID is required'))
+    if sum(v is not None for v in [container_public_id, container_slug]) != 1:
+        typer.echo("Please provide a single identifier for container - ID or name.")
         raise typer.Exit(1)
 
     service_factory = validate_config_and_get_service_factory()
@@ -380,10 +477,11 @@ def container_logs(
 
     if logs_number is None:
         logging_service.stream_container_logs_with_controls(
-            container_uid=container_uid
+            container_public_id=container_public_id,
+            container_slug=container_slug,
         )
     else:
-        logging_service.print_last_container_logs(container_uid=container_uid, logs_number=logs_number)
+        logging_service.print_last_container_logs(container_public_id=container_public_id, container_slug=container_slug, logs_number=logs_number)
 
     app_logger.info(f'Container logs - end')
     raise typer.Exit(0)

thestage/controllers/instance_controller.py

@@ -64,8 +64,19 @@ def rented_list(
 
 @rented.command(name="connect", no_args_is_help=True, help=__("Connect to rented server instance"), **get_command_metadata(CliCommand.INSTANCE_RENTED_CONNECT))
 def instance_connect(
-        instance_uid: Optional[str] = typer.Argument(
-            help=__("Rented server instance unique ID"),
+        public_id: Optional[str] = typer.Option(
+            None,
+            '--id',
+            '-rid',
+            help="Rented instance ID",
+            is_eager=False,
+        ),
+        slug: Optional[str] = typer.Option(
+            None,
+            '--name',
+            '-rn',
+            help="Rented instance name",
+            is_eager=False,
         ),
         private_ssh_key_path: str = typer.Option(
             None,
@@ -79,8 +90,8 @@ def instance_connect(
     app_logger.info(f'Running {command_name} from {get_current_directory()}')
     check_command_permission(command_name)
 
-    if not instance_uid:
-        typer.echo(__('Rented server instance unique ID is required'))
+    if sum(v is not None for v in [public_id, slug]) != 1:
+        typer.echo("Please provide a single identifier for rented instance - ID or name.")
         raise typer.Exit(1)
 
     if private_ssh_key_path and not Path(private_ssh_key_path).is_file():
@@ -91,7 +102,8 @@ def instance_connect(
     instance_service: InstanceService = service_factory.get_instance_service()
 
     instance_service.connect_to_rented_instance(
-        instance_rented_slug=instance_uid,
+        instance_rented_public_id=public_id,
+        instance_rented_slug=slug,
         input_ssh_key_path=private_ssh_key_path
     )
 
@@ -142,7 +154,20 @@ def self_hosted_list(
 
 @self_hosted.command(name="connect", no_args_is_help=True, help=__("Connect to self-hosted instance"), **get_command_metadata(CliCommand.INSTANCE_SELF_HOSTED_CONNECT))
 def self_hosted_connect(
-        instance_slug: Optional[str] = typer.Argument(help=__("Self-hosted instance unique ID"),),
+        public_id: Optional[str] = typer.Option(
+            None,
+            '--id',
+            '-sid',
+            help="Self-hosted instance ID",
+            is_eager=False,
+        ),
+        slug: Optional[str] = typer.Option(
+            None,
+            '--name',
+            '-sn',
+            help="Self-hosted instance name",
+            is_eager=False,
+        ),
         username: Optional[str] = typer.Option(
             None,
             '--username',
@@ -162,8 +187,8 @@ def self_hosted_connect(
     app_logger.info(f'Running {command_name} from {get_current_directory()}')
     check_command_permission(command_name)
 
-    if not instance_slug:
-        typer.echo(__('Self-hosted instance unique ID is required'))
+    if sum(v is not None for v in [public_id, slug]) != 1:
+        typer.echo("Please provide a single identifier for self-hosted instance - ID or name.")
         raise typer.Exit(1)
 
     if private_ssh_key_path and not Path(private_ssh_key_path).is_file():
@@ -174,7 +199,8 @@ def self_hosted_connect(
     instance_service: InstanceService = service_factory.get_instance_service()
 
     instance_service.connect_to_selfhosted_instance(
-        selfhosted_instance_slug=instance_slug,
+        selfhosted_instance_public_id=public_id,
+        selfhosted_instance_slug=slug,
         username=username,
         input_ssh_key_path=private_ssh_key_path
     )