RSDK-4756 - add Options api-key helper function (#469)

Author: stuqdog

src/viam/robot/client.py

@@ -101,6 +101,26 @@ class Options:
         Whether sessions are disabled
         """
 
+        @classmethod
+        def with_api_key(cls, api_key: str, api_key_id: str) -> Self:
+            """
+            Create RobotClient.Options with an API key for credentials and default values for other arguments.
+
+            Args:
+                api_key (str): your API key
+                api_key_id (str): your API key ID. Must be a valid UUID
+
+            Raises:
+                ValueError: Raised if the api_key_id is not a valid UUID
+
+            Returns:
+                Self: the RobotClient.Options
+            """
+            dial_opts = DialOptions.with_api_key(api_key, api_key_id)
+            self = cls()
+            self.dial_options = dial_opts
+            return self
+
     @classmethod
     async def at_address(cls, address: str, options: Options) -> Self:
         """Create a robot client that is connected to the robot at the provided address.

src/viam/rpc/dial.py

@@ -4,9 +4,11 @@
 import socket
 import ssl
 import sys
+import uuid
 import warnings
 from dataclasses import dataclass
 from typing import Callable, Literal, Optional, Tuple, Type, Union
+from typing_extensions import Self
 
 from grpclib.client import Channel, Stream
 from grpclib.const import Cardinality
@@ -90,6 +92,28 @@ def __init__(
         self.max_reconnect_attempts = max_reconnect_attempts
         self.timeout = timeout
 
+    @classmethod
+    def with_api_key(cls, api_key: str, api_key_id: str) -> Self:
+        """Create DialOptions with an API key for credentials and default values for other arguments.
+
+        Args:
+            api_key (str): your API key
+            api_key_id (str): your API key ID. Must be a valid UUID
+
+        Raises:
+            ValueError: Raised if the api_key_id is not a valid UUID
+
+        Returns:
+            Self: the DialOptions
+        """
+        try:
+            uuid.UUID(api_key_id)
+        except ValueError:
+            raise ValueError(f"{api_key_id} is not a valid UUID")
+
+        credentials = Credentials(type="api-key", payload=api_key)
+        return cls(credentials=credentials, auth_entity=api_key_id)
+
 
 def _host_port_from_url(url) -> Tuple[Optional[str], Optional[int]]:
     query = "(?:.*://)?(?P<host>[^:/ ]+).?(?P<port>[0-9]*).*"