adds deprecation notices

Author: davidvonthenen

deepgram/client.py

@@ -6,6 +6,9 @@
 from importlib import import_module
 import os
 
+import deprecation
+
+from . import __version__
 import logging
 from .utils import verboselogs
 
@@ -257,11 +260,16 @@ def speak(self):
  """
  return Speak(self._config)
 
- # TODO: legacy
  @property
+ @deprecation.deprecated(
+ deprecated_in="3.4.0",
+ removed_in="4.0.0",
+ current_version=__version__,
+ details="deepgram.asyncspeak is deprecated. Use deepgram.speak.asyncrest instead.",
+ )
  def asyncspeak(self):
  """
- TODO: LEGACY - Returns an AsyncSpeakClient instance for interacting with Deepgram's speak services.
+ DEPRECATED: deepgram.asyncspeak is deprecated. Use deepgram.speak.asyncrest instead.
  """
  return self.Version(self._config, "asyncspeak")
 
@@ -279,11 +287,16 @@ def asyncmanage(self):
  """
  return self.Version(self._config, "asyncmanage")
 
- # for backwards compatibility
  @property
+ @deprecation.deprecated(
+ deprecated_in="3.4.0",
+ removed_in="4.0.0",
+ current_version=__version__,
+ details="deepgram.onprem is deprecated. Use deepgram.speak.selfhosted instead.",
+ )
  def onprem(self):
  """
- Returns an SelfHostedClient instance for interacting with Deepgram's on-premises API.
+ DEPRECATED: deepgram.onprem is deprecated. Use deepgram.speak.selfhosted instead.
  """
  return self.Version(self._config, "selfhosted")
 
@@ -294,11 +307,16 @@ def selfhosted(self):
  """
  return self.Version(self._config, "selfhosted")
 
- # for backwards compatibility
  @property
+ @deprecation.deprecated(
+ deprecated_in="3.4.0",
+ removed_in="4.0.0",
+ current_version=__version__,
+ details="deepgram.asynconprem is deprecated. Use deepgram.speak.asyncselfhosted instead.",
+ )
  def asynconprem(self):
  """
- Returns an AsyncSelfHostedClient instance for interacting with Deepgram's on-premises API.
+ DEPRECATED: deepgram.asynconprem is deprecated. Use deepgram.speak.asyncselfhosted instead.
  """
  return self.Version(self._config, "asyncselfhosted")
 
@@ -364,16 +382,7 @@ def v(self, version: str = ""):
  filename = "async_client"
  classname = "AsyncManageClient"
  case "asyncspeak":
- # TODO: legacy
  return AsyncSpeakRESTClient(self._config)
- case "speak-stream":
- parent = "speak"
- filename = "client_stream"
- classname = "SpeakWebSocketClient"
- case "asyncspeak-stream":
- parent = "speak"
- filename = "async_client_stream"
- classname = "AsyncSpeakWebSocketClient"
  case "selfhosted":
  parent = "selfhosted"
  filename = "client"

deepgram/clients/listen_router.py

@@ -5,6 +5,9 @@
 from importlib import import_module
 import logging
 
+import deprecation
+
+from .. import __version__
 from .listen.v1 import (
  PreRecordedClient,
  AsyncPreRecordedClient,
@@ -46,35 +49,55 @@ def __init__(self, config: DeepgramClientOptions):
  self._logger.setLevel(config.verbose)
  self._config = config
 
- # TODO: legacy
  @property
+ @deprecation.deprecated(
+ deprecated_in="3.4.0",
+ removed_in="4.0.0",
+ current_version=__version__,
+ details="deepgram.listen.prerecorded is deprecated. Use deepgram.listen.rest instead.",
+ )
  def prerecorded(self):
  """
- TODO: Returns a PreRecordedClient instance for interacting with Deepgram's prerecorded transcription services.
+ DEPRECATED: deepgram.listen.prerecorded is deprecated. Use deepgram.listen.rest instead.
  """
  return self.Version(self._config, "prerecorded")
 
- # TODO: legacy
  @property
+ @deprecation.deprecated(
+ deprecated_in="3.4.0",
+ removed_in="4.0.0",
+ current_version=__version__,
+ details="deepgram.listen.asyncprerecorded is deprecated. Use deepgram.listen.asyncrest instead.",
+ )
  def asyncprerecorded(self):
  """
- TODO: Returns an AsyncPreRecordedClient instance for interacting with Deepgram's prerecorded transcription services.
+ DEPRECATED: deepgram.listen.asyncprerecorded is deprecated. Use deepgram.listen.asyncrest instead.
  """
  return self.Version(self._config, "asyncprerecorded")
 
- # TODO: legacy
  @property
+ @deprecation.deprecated(
+ deprecated_in="3.4.0",
+ removed_in="4.0.0",
+ current_version=__version__,
+ details="deepgram.listen.live is deprecated. Use deepgram.listen.websocket instead.",
+ )
  def live(self):
  """
- TODO: Returns a LiveClient instance for interacting with Deepgram's transcription services.
+ DEPRECATED: deepgram.listen.live is deprecated. Use deepgram.listen.websocket instead.
  """
  return self.Version(self._config, "live")
 
- # TODO: legacy
  @property
+ @deprecation.deprecated(
+ deprecated_in="3.4.0",
+ removed_in="4.0.0",
+ current_version=__version__,
+ details="deepgram.listen.asynclive is deprecated. Use deepgram.listen.asyncwebsocket instead.",
+ )
  def asynclive(self):
  """
- TODO: Returns an AsyncLiveClient instance for interacting with Deepgram's transcription services.
+ DEPRECATED: deepgram.listen.asynclive is deprecated. Use deepgram.listen.asyncwebsocket instead.
  """
  return self.Version(self._config, "asynclive")
 
@@ -151,16 +174,12 @@ def v(self, version: str = ""):
  class_name = ""
  match self._parent:
  case "live":
- # TODO: legacy
  return LiveClient(self._config)
  case "asynclive":
- # TODO: legacy
  return AsyncLiveClient(self._config)
  case "prerecorded":
- # TODO: legacy
  return PreRecordedClient(self._config)
  case "asyncprerecorded":
- # TODO: legacy
  return AsyncPreRecordedClient(self._config)
  case "websocket":
  protocol = "websocket"

deepgram/clients/speak_router.py

@@ -5,6 +5,9 @@
 from importlib import import_module
 import logging
 
+import deprecation
+
+from .. import __version__
 from .speak.v1.rest.client import SpeakRESTClient
 from ..utils import verboselogs
 from ..options import DeepgramClientOptions
@@ -35,10 +38,15 @@ def __init__(self, config: DeepgramClientOptions):
  self._logger.setLevel(config.verbose)
  self._config = config
 
- # TODO: legacy
+ @deprecation.deprecated(
+ deprecated_in="3.4.0",
+ removed_in="4.0.0",
+ current_version=__version__,
+ details="deepgram.speak.v1 is deprecated. Use deepgram.speak.rest or deepgram.speak.websocket instead.",
+ )
  def v(self, version: str = ""):
  """
- TODO: legacy
+ DEPRECATED: deepgram.speak.v1 is deprecated. Use deepgram.speak.rest or deepgram.speak.websocket instead.
  """
  return SpeakRESTClient(self._config)
 

pyproject.toml

@@ -37,6 +37,7 @@ dataclasses-json = "^0.6.3"
 aiohttp = "^3.9.1"
 aiofiles = "^23.2.1"
 aenum = "^3.1.0"
+deprecation = "^2.1.0"
 # needed only if you are looking to develop/work-on the SDK
 # black = "^24.0"
 # pylint = "^3.0"

requirements.txt

@@ -1,13 +1,14 @@
 # pip install -r requirements.txt
 
 # standard libs
-websockets
-httpx
-dataclasses-json
-dataclasses
-typing_extensions
-aenum
+websockets==12.*
+httpx==0.*
+dataclasses-json==0.*
+dataclasses==0.*
+typing_extensions==4.*
+aenum==3.*
+deprecation==2.*
 
 # Async functionality, likely to be already installed
-aiohttp
-aiofiles
+aiohttp==3.*
+aiofiles==23.*

setup.py

@@ -34,6 +34,7 @@
  "aiohttp>=3.9.1",
  "aiofiles>=23.2.1",
  "aenum>=3.1.0",
+ "deprecation>=2.1.0",
  ],
  keywords=["deepgram", "deepgram speech-to-text"],
  classifiers=[