Merge pull request #46 from video-db/release-0-2-16

feat: unified `upload()` API, meeting recording flow, custom headers & gen-AI text (v0.2.16)

Author: ashish-spext

README.md

@@ -74,14 +74,15 @@ conn = videodb.connect(api_key="YOUR_API_KEY")
 Now that you have established a connection to VideoDB, you can upload your videos using `conn.upload()`.
 You can directly upload from `youtube`, `any public url`, `S3 bucket` or a `local file path`. A default collection is created when you create your first connection.
 
-`upload` method returns a `Video` object.
+`upload` method returns a `Video` object. You can simply pass a single string
+representing either a local file path or a URL.
 
 ```python
 # Upload a video by url
-video = conn.upload(url="https://www.youtube.com/watch?v=WDv4AWk0J3U")
+video = conn.upload("https://www.youtube.com/watch?v=WDv4AWk0J3U")
 
 # Upload a video from file system
-video_f = conn.upload(file_path="./my_video.mp4")
+video_f = conn.upload("./my_video.mp4")
 
 ```
 
@@ -147,9 +148,9 @@ In the future you'll be able to index videos using:
 coll = conn.get_collection()
 
 # Upload Videos to a collection
-coll.upload(url="https://www.youtube.com/watch?v=lsODSDmY4CY")
-coll.upload(url="https://www.youtube.com/watch?v=vZ4kOr38JhY")
-coll.upload(url="https://www.youtube.com/watch?v=uak_dXHh6s4")
+coll.upload("https://www.youtube.com/watch?v=lsODSDmY4CY")
+coll.upload("https://www.youtube.com/watch?v=vZ4kOr38JhY")
+coll.upload("https://www.youtube.com/watch?v=uak_dXHh6s4")
 ```
 
 - `conn.get_collection()` : Returns a Collection object; the default collection.

videodb/__about__.py

@@ -1,8 +1,6 @@
-""" About information for videodb sdk"""
+"""About information for videodb sdk"""
 
-
-
-__version__ = "0.2.15"
+__version__ = "0.2.16"
 __title__ = "videodb"
 __author__ = "videodb"
 __email__ = "[email protected]"

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/_constants.py

@@ -77,17 +77,26 @@ class ApiPath:
     alert = "alert"
     generate_url = "generate_url"
     generate = "generate"
+    text = "text"
     web = "web"
     translate = "translate"
     dub = "dub"
     transcode = "transcode"
+    meeting = "meeting"
+    record = "record"
 
 
 class Status:
     processing = "processing"
     in_progress = "in progress"
 
 
+class MeetingStatus:
+    initializing = "initializing"
+    processing = "processing"
+    done = "done"
+
+
 class HttpClientDefaultValues:
     max_retries = 1
     timeout = 30

videodb/_upload.py

@@ -1,7 +1,9 @@
 import requests
 
 from typing import Optional
+from urllib.parse import urlparse
 from requests import HTTPError
+import os
 
 
 from videodb._constants import (
@@ -13,15 +15,50 @@
 )
 
 
+def _is_url(path: str) -> bool:
+    parsed = urlparse(path)
+    return all([parsed.scheme in ("http", "https"), parsed.netloc])
+
+
 def upload(
     _connection,
-    file_path: str = None,
-    url: str = None,
+    source: Optional[str] = None,
     media_type: Optional[str] = None,
     name: Optional[str] = None,
     description: Optional[str] = None,
     callback_url: Optional[str] = None,
+    file_path: Optional[str] = None,
+    url: Optional[str] = None,
 ) -> dict:
+    """Upload a file or URL.
+
+    :param _connection: Connection object for API calls
+    :param str source: Local path or URL of the file to be uploaded
+    :param str media_type: MediaType object (optional)
+    :param str name: Name of the file (optional)
+    :param str description: Description of the file (optional)
+    :param str callback_url: URL to receive the callback (optional)
+    :param str file_path: Path to the file to be uploaded
+    :param str url: URL of the file to be uploaded
+    :return: Dictionary containing upload response data
+    :rtype: dict
+    """
+    if source and (file_path or url):
+        raise VideodbError("source cannot be used with file_path or url")
+
+    if source and not file_path and not url:
+        if _is_url(source):
+            url = source
+        else:
+            file_path = source
+    if file_path and not url and _is_url(file_path):
+        url = file_path
+        file_path = None
+
+    if not file_path and url and not _is_url(url) and os.path.exists(url):
+        file_path = url
+        url = None
+
     if not file_path and not url:
         raise VideodbError("Either file_path or url is required")
     if file_path and url:

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

@@ -18,6 +18,7 @@
 from videodb.video import Video
 from videodb.audio import Audio
 from videodb.image import Image
+from videodb.meeting import Meeting
 
 from videodb._upload import (
     upload,
@@ -29,7 +30,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 +45,9 @@ 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.
@@ -256,32 +259,35 @@ def get_transcode_details(self, job_id: str) -> dict:
 
     def upload(
         self,
-        file_path: str = None,
-        url: str = None,
+        source: Optional[str] = None,
         media_type: Optional[str] = None,
         name: Optional[str] = None,
         description: Optional[str] = None,
         callback_url: Optional[str] = None,
+        file_path: Optional[str] = None,
+        url: Optional[str] = None,
     ) -> Union[Video, Audio, Image, None]:
         """Upload a file.
 
-        :param str file_path: Path to the file to upload (optional)
-        :param str url: URL of the file to upload (optional)
+        :param str source: Local path or URL of the file to upload (optional)
         :param MediaType media_type: MediaType object (optional)
         :param str name: Name of the file (optional)
         :param str description: Description of the file (optional)
         :param str callback_url: URL to receive the callback (optional)
+        :param str file_path: Path to the file to upload (optional)
+        :param str url: URL of the file to upload (optional)
         :return: :class:`Video <Video>`, or :class:`Audio <Audio>`, or :class:`Image <Image>` object
         :rtype: Union[ :class:`videodb.video.Video`, :class:`videodb.audio.Audio`, :class:`videodb.image.Image`]
         """
         upload_data = upload(
             self,
-            file_path,
-            url,
-            media_type,
-            name,
-            description,
-            callback_url,
+            source,
+            media_type=media_type,
+            name=name,
+            description=description,
+            callback_url=callback_url,
+            file_path=file_path,
+            url=url,
         )
         media_id = upload_data.get("id", "")
         if media_id.startswith("m-"):
@@ -290,3 +296,54 @@ def upload(
             return Audio(self, **upload_data)
         elif media_id.startswith("img-"):
             return Image(self, **upload_data)
+
+    def record_meeting(
+        self,
+        meeting_url: str,
+        bot_name: str = None,
+        bot_image_url: str = None,
+        meeting_title: str = None,
+        callback_url: str = None,
+        callback_data: Optional[dict] = None,
+        time_zone: str = "UTC",
+    ) -> Meeting:
+        """Record a meeting and upload it to the default collection.
+
+        :param str meeting_url: Meeting url
+        :param str bot_name: Name of the recorder bot
+        :param str bot_image_url: URL of the recorder bot image
+        :param str meeting_title: Name of the meeting
+        :param str callback_url: URL to receive callback once recording is done
+        :param dict callback_data: Data to be sent in the callback (optional)
+        :param str time_zone: Time zone for the meeting (default ``UTC``)
+        :return: :class:`Meeting <Meeting>` object representing the recording bot
+        :rtype: :class:`videodb.meeting.Meeting`
+        """
+        if callback_data is None:
+            callback_data = {}
+
+        response = self.post(
+            path=f"{ApiPath.collection}/default/{ApiPath.meeting}/{ApiPath.record}",
+            data={
+                "meeting_url": meeting_url,
+                "bot_name": bot_name,
+                "bot_image_url": bot_image_url,
+                "meeting_title": meeting_title,
+                "callback_url": callback_url,
+                "callback_data": callback_data,
+                "time_zone": time_zone,
+            },
+        )
+        meeting_id = response.get("meeting_id")
+        return Meeting(self, id=meeting_id, collection_id="default", **response)
+
+    def get_meeting(self, meeting_id: str) -> Meeting:
+        """Get a meeting by its ID.
+
+        :param str meeting_id: ID of the meeting
+        :return: :class:`Meeting <Meeting>` object
+        :rtype: :class:`videodb.meeting.Meeting`
+        """
+        meeting = Meeting(self, id=meeting_id, collection_id="default")
+        meeting.refresh()
+        return meeting