using user-agent to start tracing client usage

earthaccess/auth.py

@@ -6,11 +6,20 @@
 from typing import Any, Dict, List, Optional
 from urllib.parse import urlparse
 
+
 import requests  # type: ignore
 from tinynetrc import Netrc
 
 from .daac import DAACS
 
+import importlib.metadata
+
+try:
+    user_agent = f"earthaccess v{importlib.metadata.version('earthacess')}"
+except importlib.metadata.PackageNotFoundError:
+    user_agent = "earthaccess"
+
+
 logger = logging.getLogger(__name__)
 
 
@@ -31,6 +40,9 @@ def __init__(
         self, username: Optional[str] = None, password: Optional[str] = None
     ) -> None:
         super().__init__()
+        self.headers.update({"User-Agent": user_agent})
+
+
         if username and password:
             self.auth = (username, password)
 

tests/unit/test_auth.py

@@ -39,11 +39,17 @@ def test_auth_gets_proper_credentials(self, user_input, user_password) -> bool:
 
         # Test
         auth = Auth()
+        session = auth.get_session()
+        headers = session.headers
         self.assertEqual(auth.authenticated, False)
         auth.login(strategy="interactive")
         self.assertEqual(auth.authenticated, True)
         self.assertTrue(auth.token in json_response)
 
+        # test that we are creaintg a session with the proper headers
+        self.assertTrue("User-Agent" in headers)
+        self.assertTrue("earthaccess" in headers["User-Agent"])
+
     @responses.activate
     @mock.patch("getpass.getpass")
     @mock.patch("builtins.input")