Allow custom headers while connect

Author: ashish-spext

videodb/__init__.py

@@ -58,6 +58,7 @@ def connect(
     api_key: str = None,
     base_url: Optional[str] = VIDEO_DB_API,
     log_level: Optional[int] = logging.INFO,
+    **kwargs,
 ) -> Connection:
     """A client for interacting with a videodb via REST API
 
@@ -76,4 +77,4 @@ def connect(
             "No API key provided. Set an API key either as an environment variable (VIDEO_DB_API_KEY) or pass it as an argument."
         )
 
-    return Connection(api_key, base_url)
+    return Connection(api_key, base_url, **kwargs)

videodb/_utils/_http_client.py

@@ -34,6 +34,7 @@ def __init__(
         base_url: str,
         version: str,
         max_retries: Optional[int] = HttpClientDefaultValues.max_retries,
+        **kwargs,
     ) -> None:
         """Create a new http client instance
 
@@ -52,11 +53,13 @@ def __init__(
         self.session.mount("http://", adapter)
         self.session.mount("https://", adapter)
         self.version = version
+        kwargs = self._format_headers(kwargs)
         self.session.headers.update(
             {
                 "x-access-token": api_key,
                 "x-videodb-client": f"videodb-python/{self.version}",
                 "Content-Type": "application/json",
+                **kwargs,
             }
         )
         self.base_url = base_url
@@ -198,6 +201,14 @@ def _parse_response(self, response: requests.Response):
                 f"Invalid request: {response.text}", response
             ) from None
 
+    def _format_headers(self, headers: dict):
+        """Format the headers"""
+        formatted_headers = {}
+        for key, value in headers.items():
+            key = key.lower().replace("_", "-")
+            formatted_headers[f"x-{key}"] = value
+        return formatted_headers
+
     def get(
         self, path: str, show_progress: Optional[bool] = False, **kwargs
     ) -> requests.Response:

videodb/client.py

@@ -29,7 +29,7 @@
 class Connection(HttpClient):
     """Connection class to interact with the VideoDB"""
 
-    def __init__(self, api_key: str, base_url: str) -> "Connection":
+    def __init__(self, api_key: str, base_url: str, **kwargs) -> "Connection":
         """Initializes a new instance of the Connection class with specified API credentials.
 
         Note: Users should not initialize this class directly.
@@ -44,7 +44,7 @@ def __init__(self, api_key: str, base_url: str) -> "Connection":
         self.api_key = api_key
         self.base_url = base_url
         self.collection_id = "default"
-        super().__init__(api_key=api_key, base_url=base_url, version=__version__)
+        super().__init__(api_key=api_key, base_url=base_url, version=__version__, **kwargs)
 
     def get_collection(self, collection_id: Optional[str] = "default") -> Collection:
         """Get a collection object by its ID.