Restructure Python v3 (Part 2) - Update Project Settings

.github/workflows/CD.yml

@@ -12,8 +12,8 @@ jobs:
         with:
           python-version: '3.10' 
 
-      - name: Update Version in _version.py
-        run: sed -i 's/0.0.0/${{ github.event.release.tag_name }}/g' ./deepgram/_version.py
+      - name: Update Version in __init__.py
+        run: sed -i 's/0.0.0/${{ github.event.release.tag_name }}/g' ./deepgram/__init__.py
 
       - name: Install Dependencies
         run: pip install .

.gitignore

@@ -1,8 +1,8 @@
 *.egg-info
-*/__pycache__/
-**/__pycache__/
+__pycache__
 dist/
 .venv
+.env
 venv/
 venv.bak/
 build/

deepgram/__init__.py

@@ -1,30 +1,17 @@
-from deepgram.deepgram_client import DeepgramClient
-from .types.deepgram_client_options import DeepgramClientOptions
-
-
-def create_client(api_key: str, config_options: DeepgramClientOptions = None) -> DeepgramClient:
-    """
-    Create a DeepgramClient instance with the provided API key and optional configuration options.
-
-    This function initializes and returns a DeepgramClient instance, which can be used to interact with the Deepgram API. You can provide an API key for authentication and customize the client's configuration by passing a DeepgramClientOptions object.
+# version
+__version__ = '0.0.0'
 
-    Args:
-        api_key (str): The Deepgram API key used for authentication.
-        config_options (DeepgramClientOptions, optional): An optional configuration object specifying client options. If not provided, the default settings will be used.
-
-    Returns:
-        DeepgramClient: An instance of the DeepgramClient class for making requests to the Deepgram API.
-
-    Example usage:
-        To create a DeepgramClient instance with a custom configuration:
+# entry point for the deepgram python sdk
+from .deepgram_client import DeepgramClient
+from .types.deepgram_client_options import DeepgramClientOptions
+from .errors import DeepgramError, DeepgramApiError, DeepgramUnknownApiError, DeepgramUnknownError
 
-        >>> api_key = "your_api_key"
-        >>> custom_options = DeepgramClientOptions(global_options={"url": "custom_url", "headers": {"Custom-Header": "value"}})
-        >>> client = create_client(api_key, config_options=custom_options)
+# live
+from .types.transcription_options import LiveOptions
+from .enums import LiveTranscriptionEvents
 
-    Example usage with default settings:
+# prerecorded
+from .types.transcription_options import PrerecordedOptions
 
-        >>> api_key = "your_api_key"
-        >>> client = create_client(api_key)
-    """
-    return DeepgramClient(api_key, config_options)
+# manage
+from .clients.manage_client import ManageClient

deepgram/clients/prerecorded_client.py

@@ -108,7 +108,6 @@ async def transcribe_file(self, source: FileSource, options: PrerecordedOptions
         """
 
         url = f"{self.url}/{endpoint}"
-        await self._set_file_mimetype_headers(source)
         if is_buffer_source(source):
             body = source["buffer"]
         elif is_readstream_source(source):
@@ -142,17 +141,10 @@ async def transcribe_file_callback(self, source: FileSource, callback: str, opti
         if options is None:
             options = {}
         options['callback'] = callback
-        await self._set_file_mimetype_headers(source)
         if is_buffer_source(source):
             body = source["buffer"]
         elif is_readstream_source(source):
             body = source["stream"]
         else:
             raise DeepgramError("Unknown transcription source type")
         return await self.post(url, options, content=body)
-
-    async def _set_file_mimetype_headers(self, source: FileSource) -> None:
-        if "mimetype" not in source or not source["mimetype"]:
-            raise DeepgramError(
-                "Mimetype must be provided if the source is a Buffer or a Readable")
-        self.headers["Content-Type"] = source["mimetype"]

deepgram/deepgram_client.py

@@ -26,7 +26,7 @@ class DeepgramClient:
         onprem: Returns an OnPremClient instance for interacting with Deepgram's on-premises API.
 
     """
-    def __init__(self, api_key: str, config_options: Optional[DeepgramClientOptions]):
+    def __init__(self, api_key: str, config_options: Optional[DeepgramClientOptions] = None):
         if not api_key:
             raise DeepgramError("Deepgram API key is required")
 

deepgram/errors.py

@@ -1,5 +1,4 @@
 
-
 class DeepgramError(Exception):
     """
     Base class for exceptions raised by the Deepgram API client.

deepgram/types/transcription_options.py

@@ -1,24 +1,5 @@
 from typing import Union, List, TypedDict
 
-class TranscriptionOptions(TypedDict, total=False):
-    callback: str
-    diarize: bool
-    keywords: Union[List[str], str]
-    language: str
-    model: str
-    multichannel: bool
-    numerals: bool
-    punctuate: bool
-    profanity_filter: bool
-    redact: Union[List[str], List[bool], bool]
-    replace: Union[List[str], str]
-    search: Union[List[str], str]
-    smart_format: bool
-    tag: List[str]
-    tier: str
-    version: str
-
-
 class PrerecordedOptions(TypedDict, total=False):
     alternatives: int
     callback: str

examples/demo_live.py

@@ -1,5 +1,4 @@
-from deepgram import create_client, DeepgramClient
-from deepgram.enums import LiveTranscriptionEvents
+from deepgram import DeepgramClient, LiveTranscriptionEvents, LiveOptions
 from dotenv import load_dotenv
 import asyncio
 import aiohttp
@@ -21,7 +20,7 @@
         }
     }
 
-options = {
+options: LiveOptions = {
       'model': 'nova',
       'interim_results': False,
       'language': 'en-US'
@@ -34,8 +33,7 @@
 
 
 async def main():
-  deepgram: DeepgramClient = create_client(deepgram_api_key)
-  # deepgram: DeepgramClient = create_client(deepgram_api_key, config_options)
+  deepgram: DeepgramClient = DeepgramClient(deepgram_api_key)
 
   # Create a websocket connection to Deepgram
   try:

examples/demo_manage.py

@@ -1,6 +1,6 @@
 import asyncio
 import os
-from deepgram import create_client, DeepgramClient
+from deepgram import DeepgramClient
 from dotenv import load_dotenv
 load_dotenv()
 
@@ -19,7 +19,7 @@
 }
 
 # Create a Deepgram client using the API key
-deepgram: DeepgramClient = create_client(API_KEY)
+deepgram: DeepgramClient = DeepgramClient(API_KEY)
 
 
 async def main():

examples/demo_prerecorded.py

@@ -1,47 +1,43 @@
+from deepgram import DeepgramClient, PrerecordedOptions
 import asyncio
 import os
-from deepgram import create_client
-from deepgram.deepgram_client import DeepgramClient
 from dotenv import load_dotenv
 load_dotenv()
 
 API_KEY = os.getenv('DG_API_KEY')
 AUDIO_FILE = "preamble.wav"
-AUDIO_URL = {
-    "url": "https://static.deepgram.com/examples/Bueller-Life-moves-pretty-fast.wav"}
-OPTIONS = {
+AUDIO_URL = {"url":"https://static.deepgram.com/examples/Bueller-Life-moves-pretty-fast.wav"}
+CALLBACK = "https://example.com/callback"
+
+options: PrerecordedOptions = {
     "model": "nova",
     "smart_format": "true",
     "summarize": "v2",
 }
-CALLBACK = "https://example.com/callback"
 
 # STEP 1 Create a Deepgram client using the API key (optional - add config options)
-deepgram: DeepgramClient = create_client(API_KEY)
-
+deepgram = DeepgramClient(API_KEY)
 
 ###### TRANSCRIBE A LOCAL FILE #####
-
-# Logic to read the file
 async def transcribe_file():
+    # Logic to read the file
     with open(AUDIO_FILE, 'rb') as file:
         buffer_data = file.read()
 
     PAYLOAD = {
         "buffer": buffer_data,
-        "mimetype": "audio/wav",
     }
 
     # STEP 2 Call the transcribe_file method on the prerecorded class
-    file_response = await deepgram.listen.prerecorded.transcribe_file(PAYLOAD, OPTIONS)
+    file_response = await deepgram.listen.prerecorded.transcribe_file(PAYLOAD, options)
     return file_response
 
 
 ###### TRANSCRIBE A HOSTED FILE #####
 async def transcribe_url():
     # STEP 2 Call the transcribe_url method on the prerecorded class
-    url_response = await deepgram.listen.prerecorded.transcribe_url(AUDIO_URL, OPTIONS)
-    # url_response = await deepgram.listen.prerecorded.transcribe_url_callback(AUDIO_URL,CALLBACK, OPTIONS)
+    url_response = await deepgram.listen.prerecorded.transcribe_url(AUDIO_URL, options)
+    # url_response = await deepgram.listen.prerecorded.transcribe_url_callback(AUDIO_URL,CALLBACK, options)
     return url_response
 
 

examples/requirements.txt

@@ -1,4 +1,4 @@
--e ../../
+-e ../
 httpx
 typing_extensions
 python-dotenv

pyproject.toml

@@ -1,3 +1,10 @@
 [build-system]
 requires = ["setuptools", "wheel"]
-build-backend = "setuptools.build_meta"
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "deepgram-sdk"
+dynamic = ["version"]
+
+[tool.setuptools.dynamic]
+version = {attr = "deepgram.__version__"}

setup.py

@@ -1,18 +1,10 @@
 import setuptools
 import os.path
 
-# from official Python version-detection recommendations: https://packaging.python.org/guides/single-sourcing-package-version/
-
-with open(os.path.join(os.path.abspath(os.path.dirname(__file__)), 'deepgram', '_version.py'), encoding="utf8") as file:
-    exec(file.read())
-# imports as __version__
-
 with open(os.path.join(os.path.abspath(os.path.dirname(__file__)), 'README.md'), encoding="utf8") as file:
     long_description = file.read()
 
 setuptools.setup(
-    name='deepgram-sdk',
-    version=__version__, # type: ignore
     description='The official Python SDK for the Deepgram automated speech recognition platform.',
     long_description=long_description,
     long_description_content_type='text/markdown',