Implemented convenience method for client id

cmr/queries.py

@@ -8,6 +8,7 @@
 from inspect import getmembers, ismethod
 from re import search
 from typing import Iterator
+from importlib.metadata import version
 
 from typing_extensions import (
     Any,
@@ -59,6 +60,7 @@ def __init__(self, route: str, mode: str = CMR_OPS):
         self.mode(mode)
         self.concept_id_chars: Set[str] = set()
         self.headers: MutableMapping[str, str] = {}
+        self.headers.update({"Client-Id": f"python_cmr-v{version('python_cmr')}"})
 
     @deprecated("Use the 'results' method instead, but note that it produces an iterator.")
     def get(self, limit: int = 2000) -> Sequence[Any]:
@@ -365,6 +367,26 @@ def bearer_token(self, bearer_token: str) -> Self:
 
         return self
 
+    def client_id(self, id_: str) -> Self:
+        """
+        Set the value of this query's `Client-Id` header.
+
+        Otherwise, set the header value to the specified value along with
+        the suffix `(python_cmr-vX.Y.Z)`, separated by a space character.
+
+        :param client_id
+        :returns self
+        """
+
+        if not id_: 
+            return self
+
+        self.headers.update(
+            {"Client-Id": f"{id_} python_cmr-v{version('python_cmr')}"}
+        )
+
+        return self
+
     def option(
         self, parameter: str, key: str, value: Union[str, bool, int, float, None]
     ) -> Self:

tests/test_queries.py

@@ -1,5 +1,5 @@
 from cmr import Query
-
+from importlib.metadata import version
 
 class MockQuery(Query):
     def _valid_state(self) -> bool:
@@ -8,7 +8,8 @@ def _valid_state(self) -> bool:
 
 def test_query_headers_initially_empty():
     query = MockQuery("/foo")
-    assert query.headers == {}
+    expected_version = version("python_cmr")
+    assert query.headers == {"Client-Id": f"python_cmr-v{expected_version}"}
 
 
 def test_bearer_token_adds_header():
@@ -55,3 +56,11 @@ def test_token_replaces_existing_auth_header():
     query.token("token")
 
     assert query.headers["Authorization"] == "token"
+
+def test_client_id_sets_header():
+    query = MockQuery("/foo")
+    query.client_id("test_client")
+    query.token("token")
+
+    expected_version = version("python_cmr")
+    assert query.headers["Client-Id"] == f"test_client python_cmr-v{expected_version}"