(small) Add SDK version to API requests (#135)

Co-authored-by: Auto-format Bot <[email protected]>

Author: mjvogelsong

src/groundlight/__init__.py

@@ -5,13 +5,6 @@
 # Imports from our code
 from .client import Groundlight
 from .binary_labels import Label
+from .version import get_version
 
-try:
-    import importlib.metadata
-
-    # Copy the version number from where it's set in pyproject.toml
-    __version__ = importlib.metadata.version("groundlight")
-except ModuleNotFoundError:
-    # importlib.metadata was only added in py3.8
-    # We're still supporting py3.7
-    __version__ = "(version number available in python 3.8+)"
+__version__ = get_version()

src/groundlight/internalapi.py

@@ -14,6 +14,7 @@
 
 from groundlight.images import ByteStreamWrapper
 from groundlight.status_codes import is_ok
+from groundlight.version import get_version
 
 logger = logging.getLogger("groundlight.sdk")
 
@@ -186,6 +187,9 @@ def _headers(self) -> dict:
             "Content-Type": "application/json",
             "x-api-token": self.configuration.api_key["ApiToken"],
             "X-Request-Id": request_id,
+            # This metadata helps us debug issues with specific SDK versions.
+            "x-sdk-version": get_version(),
+            "x-sdk-language": "python",
         }
 
     @RequestsRetryDecorator()

src/groundlight/version.py

@@ -0,0 +1,10 @@
+def get_version() -> str:
+    try:
+        import importlib.metadata  # pylint: disable=import-outside-toplevel
+
+        # Copy the version number from where it's set in pyproject.toml
+        return importlib.metadata.version("groundlight")
+    except ModuleNotFoundError:
+        # importlib.metadata was only added in py3.8
+        # We're still supporting py3.7
+        return "(version number available in python 3.8+)"