Allow specifying the User-Agent when creating a GalaxyClient

bioblend/galaxy/__init__.py

@@ -41,6 +41,7 @@ def __init__(
         password: Optional[str] = None,
         *,
         verify: bool = True,
+        user_agent: Optional[str] = None,
     ) -> None:
         """
         A base representation of a connection to a Galaxy instance, identified
@@ -83,7 +84,7 @@ def __init__(
         :param verify: Whether to verify the server's TLS certificate
         :type verify: bool
         """
-        super().__init__(url, key=key, email=email, password=password, verify=verify)
+        super().__init__(url, key=key, email=email, password=password, verify=verify, user_agent=user_agent)
         self.libraries = libraries.LibraryClient(self)
         self.histories = histories.HistoryClient(self)
         self.workflows = workflows.WorkflowClient(self)

bioblend/galaxy/objects/galaxy_instance.py

@@ -58,8 +58,11 @@ def __init__(
         password: Optional[str] = None,
         *,
         verify: bool = True,
+        user_agent: Optional[str] = None,
     ) -> None:
-        self.gi = bioblend.galaxy.GalaxyInstance(url, key=api_key, email=email, password=password, verify=verify)
+        self.gi = bioblend.galaxy.GalaxyInstance(
+            url, key=api_key, email=email, password=password, verify=verify, user_agent=user_agent
+        )
         self.log = bioblend.log
         self.datasets = client.ObjDatasetClient(self)
         self.dataset_collections = client.ObjDatasetCollectionClient(self)

bioblend/galaxyclient.py

@@ -42,6 +42,7 @@ def __init__(
         *,
         verify: bool = True,
         timeout: Optional[float] = None,
+        user_agent: Optional[str] = None,
     ) -> None:
         """
         :param verify: Whether to verify the server's TLS certificate
@@ -81,6 +82,8 @@ def __init__(
             self.email = email
             self.password = password
         self.json_headers: Dict[str, Union[str, bytes, None]] = {"Content-Type": "application/json"}
+        if user_agent:
+            self.json_headers["User-Agent"] = user_agent
         # json_headers needs to be set before key can be defined, otherwise authentication with email/password causes an error
         self.json_headers["x-api-key"] = self.key
         # Number of attempts before giving up on a GET request.

bioblend/toolshed/__init__.py

@@ -21,6 +21,7 @@ def __init__(
         password: Optional[str] = None,
         *,
         verify: bool = True,
+        user_agent: Optional[str] = None,
     ) -> None:
         """
         A base representation of a connection to a ToolShed instance, identified
@@ -61,7 +62,7 @@ def __init__(
         :param verify: Whether to verify the server's TLS certificate
         :type verify: bool
         """
-        super().__init__(url, key=key, email=email, password=password, verify=verify)
+        super().__init__(url, key=key, email=email, password=password, verify=verify, user_agent=user_agent)
         self.categories = categories.ToolShedCategoryClient(self)
         self.repositories = repositories.ToolShedRepositoryClient(self)
         self.tools = tools.ToolShedToolClient(self)