Merge pull request #13 from speechmatics/client-ref-version

Add client version in client_ref when requesting a JWT

Author: dumitrugutu

CHANGELOG.md

@@ -4,6 +4,12 @@ All notable changes to this project will be documented in this file.
 
 The format is based on [Keep a Changelog](https://keepachangelog.com/en/1.0.0/).
 
+## [0.1.1] - 2025-03-26
+
+### Changed
+
+- Include the package version when requesting a JWT
+
 ## [0.1.0] - 2025-02-13
 
 ### Added

VERSION

@@ -1 +1 @@
-0.1.0
+0.1.1

speechmatics_flow/client.py

@@ -33,7 +33,7 @@
     DebugMode,
 )
 from speechmatics_flow.tool_function_param import ToolFunctionParam
-from speechmatics_flow.utils import read_in_chunks, json_utf8
+from speechmatics_flow.utils import read_in_chunks, json_utf8, get_version
 
 LOGGER = logging.getLogger(__name__)
 
@@ -652,9 +652,10 @@ async def get_temp_token(api_key):
     """
     Used to get a temporary token from management platform api
     """
+    version = get_version()
     mp_api_url = os.getenv("SM_MANAGEMENT_PLATFORM_URL", "https://mp.speechmatics.com")
     endpoint = f"{mp_api_url}/v1/api_keys?type=flow"
-    body = {"ttl": 300, "client_ref": "speechmatics-flow-python-client"}
+    body = {"ttl": 300, "sm-sdk": f"python-{version}"}
     headers = {"Authorization": f"Bearer {api_key}", "Content-Type": "application/json"}
     response = httpx.post(endpoint, json=body, headers=headers)
     response.raise_for_status()

speechmatics_flow/utils.py

@@ -5,8 +5,10 @@
 
 import asyncio
 import concurrent.futures
+import importlib.metadata
 import inspect
 import json
+from pathlib import Path
 
 
 def json_utf8(func):
@@ -50,3 +52,14 @@ async def read_in_chunks(stream, chunk_size):
         if not audio_chunk:
             break
         yield audio_chunk
+
+
+def get_version() -> str:
+    """Reads the version number from the package or VERSION file"""
+    try:
+        return importlib.metadata.version(__package__)
+    except importlib.metadata.PackageNotFoundError:
+        version_path = Path(__file__).resolve().parent.parent / "VERSION"
+        if version_path.exists():
+            return version_path.read_text(encoding="utf-8").strip()
+        return "0.0.0"