livekit-plugins-speechmatics 0.0.2__tar.gz → 1.0.0.dev5__tar.gz

livekit_plugins_speechmatics-1.0.0.dev5/.gitignore

@@ -0,0 +1,168 @@
+**/.vscode
+**/.DS_Store
+
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[cod]
+*$py.class
+
+# C extensions
+*.so
+
+# Distribution / packaging
+.Python
+build/
+develop-eggs/
+dist/
+downloads/
+eggs/
+.eggs/
+lib/
+lib64/
+parts/
+sdist/
+var/
+wheels/
+share/python-wheels/
+*.egg-info/
+.installed.cfg
+*.egg
+MANIFEST
+
+# PyInstaller
+#  Usually these files are written by a python script from a template
+#  before PyInstaller builds the exe, so as to inject date/other infos into it.
+*.manifest
+*.spec
+
+# Installer logs
+pip-log.txt
+pip-delete-this-directory.txt
+
+# Unit test / coverage reports
+htmlcov/
+.tox/
+.nox/
+.coverage
+.coverage.*
+.cache
+nosetests.xml
+coverage.xml
+*.cover
+*.py,cover
+.hypothesis/
+.pytest_cache/
+cover/
+
+# Translations
+*.mo
+*.pot
+
+# Django stuff:
+*.log
+local_settings.py
+db.sqlite3
+db.sqlite3-journal
+
+# Flask stuff:
+instance/
+.webassets-cache
+
+# Scrapy stuff:
+.scrapy
+
+# Sphinx documentation
+docs/_build/
+
+# PyBuilder
+.pybuilder/
+target/
+
+# Jupyter Notebook
+.ipynb_checkpoints
+
+# IPython
+profile_default/
+ipython_config.py
+
+# pyenv
+#   For a library or package, you might want to ignore these files since the code is
+#   intended to run in multiple environments; otherwise, check them in:
+# .python-version
+
+# pipenv
+#   According to pypa/pipenv#598, it is recommended to include Pipfile.lock in version control.
+#   However, in case of collaboration, if having platform-specific dependencies or dependencies
+#   having no cross-platform support, pipenv may install dependencies that don't work, or not
+#   install all needed dependencies.
+#Pipfile.lock
+
+# poetry
+#   Similar to Pipfile.lock, it is generally recommended to include poetry.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+#   https://python-poetry.org/docs/basic-usage/#commit-your-poetrylock-file-to-version-control
+#poetry.lock
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#pdm.lock
+#   pdm stores project-wide configurations in .pdm.toml, but it is recommended to not include it
+#   in version control.
+#   https://pdm.fming.dev/#use-with-ide
+.pdm.toml
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.venv
+env/
+venv/
+ENV/
+env.bak/
+venv.bak/
+
+# Spyder project settings
+.spyderproject
+.spyproject
+
+# Rope project settings
+.ropeproject
+
+# mkdocs documentation
+/site
+
+# mypy
+.mypy_cache/
+.dmypy.json
+dmypy.json
+
+# Pyre type checker
+.pyre/
+
+# pytype static type analyzer
+.pytype/
+
+# Cython debug symbols
+cython_debug/
+
+# PyCharm
+#  JetBrains specific template is maintained in a separate JetBrains.gitignore that can
+#  be found at https://github.com/github/gitignore/blob/main/Global/JetBrains.gitignore
+#  and can be added to the global gitignore or merged into this file.  For a more nuclear
+#  option (not recommended) you can uncomment the following to ignore the entire idea folder.
+.idea/
+
+node_modules
+
+credentials.json
+pyrightconfig.json

{livekit_plugins_speechmatics-0.0.2 → livekit_plugins_speechmatics-1.0.0.dev5}/PKG-INFO

@@ -1,35 +1,25 @@
-Metadata-Version: 2.2
+Metadata-Version: 2.4
 Name: livekit-plugins-speechmatics
-Version: 0.0.2
+Version: 1.0.0.dev5
 Summary: Agent Framework plugin for Speechmatics
-Home-page: https://github.com/livekit/agents
-License: Apache-2.0
 Project-URL: Documentation, https://docs.livekit.io
 Project-URL: Website, https://livekit.io/
 Project-URL: Source, https://github.com/livekit/agents
-Keywords: webrtc,realtime,audio,video,livekit
+Author-email: LiveKit <support@livekit.io>
+License-Expression: Apache-2.0
+Keywords: audio,livekit,realtime,video,webrtc
 Classifier: Intended Audience :: Developers
 Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Topic :: Multimedia :: Sound/Audio
-Classifier: Topic :: Multimedia :: Video
-Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3 :: Only
 Classifier: Programming Language :: Python :: 3.9
 Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
 Requires-Python: >=3.9.0
+Requires-Dist: livekit-agents>=1.0.0.dev5
 Description-Content-Type: text/markdown
-Requires-Dist: livekit-agents<1.0.0,>=0.12.16
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: project-url
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
 
 # LiveKit Plugins Speechmatics
 

{livekit_plugins_speechmatics-0.0.2 → livekit_plugins_speechmatics-1.0.0.dev5}/livekit/plugins/speechmatics/stt.py

@@ -20,9 +20,9 @@ import dataclasses
 import json
 import os
 import weakref
-from typing import Dict, List, Optional
 
 import aiohttp
+
 from livekit.agents import (
     DEFAULT_API_CONNECT_OPTIONS,
     APIConnectOptions,
@@ -57,8 +57,8 @@ class STT(stt.STT):
             url="wss://eu2.rt.speechmatics.com/v2",
         ),
         audio_settings: AudioSettings = AudioSettings(),
-        http_session: Optional[aiohttp.ClientSession] = None,
-        extra_headers: Optional[Dict] = None,
+        http_session: aiohttp.ClientSession | None = None,
+        extra_headers: dict | None = None,
     ):
         super().__init__(
             capabilities=stt.STTCapabilities(
@@ -91,9 +91,9 @@ class STT(stt.STT):
     def stream(
         self,
         *,
-        language: Optional[str] = None,
+        language: str | None = None,
         conn_options: APIConnectOptions = DEFAULT_API_CONNECT_OPTIONS,
-    ) -> "SpeechStream":
+    ) -> SpeechStream:
         config = dataclasses.replace(self._audio_settings)
         stream = SpeechStream(
             stt=self,
@@ -118,11 +118,9 @@ class SpeechStream(stt.SpeechStream):
         connection_settings: ConnectionSettings,
         conn_options: APIConnectOptions,
         http_session: aiohttp.ClientSession,
-        extra_headers: Optional[Dict] = None,
+        extra_headers: dict | None = None,
     ) -> None:
-        super().__init__(
-            stt=stt, conn_options=conn_options, sample_rate=audio_settings.sample_rate
-        )
+        super().__init__(stt=stt, conn_options=conn_options, sample_rate=audio_settings.sample_rate)
         self._transcription_config = transcription_config
         self._audio_settings = audio_settings
         self._connection_settings = connection_settings
@@ -188,9 +186,7 @@ class SpeechStream(stt.SpeechStream):
                         return
 
                     # this will trigger a reconnection, see the _run loop
-                    raise APIStatusError(
-                        message="Speechmatics connection closed unexpectedly"
-                    )
+                    raise APIStatusError(message="Speechmatics connection closed unexpectedly")
 
                 try:
                     data = json.loads(msg.data)
@@ -229,9 +225,7 @@ class SpeechStream(stt.SpeechStream):
                     await ws.close()
 
     async def _connect_ws(self) -> aiohttp.ClientWebSocketResponse:
-        api_key = self._connection_settings.api_key or os.environ.get(
-            "SPEECHMATICS_API_KEY"
-        )
+        api_key = self._connection_settings.api_key or os.environ.get("SPEECHMATICS_API_KEY")
         if api_key is None:
             raise ValueError(
                 "Speechmatics API key is required. "
@@ -244,9 +238,7 @@ class SpeechStream(stt.SpeechStream):
             "Authorization": f"Bearer {api_key}",
             **self._extra_headers,
         }
-        url = sanitize_url(
-            self._connection_settings.url, self._transcription_config.language
-        )
+        url = sanitize_url(self._connection_settings.url, self._transcription_config.language)
         return await self._session.ws_connect(
             url,
             ssl=self._connection_settings.ssl_context,
@@ -281,9 +273,7 @@ class SpeechStream(stt.SpeechStream):
                 usage_event = stt.SpeechEvent(
                     type=stt.SpeechEventType.RECOGNITION_USAGE,
                     alternatives=[],
-                    recognition_usage=stt.RecognitionUsage(
-                        audio_duration=self._speech_duration
-                    ),
+                    recognition_usage=stt.RecognitionUsage(audio_duration=self._speech_duration),
                 )
                 self._event_ch.send_nowait(usage_event)
                 self._speech_duration = 0
@@ -295,8 +285,8 @@ class SpeechStream(stt.SpeechStream):
                 raise Exception("Speechmatics connection closed unexpectedly")
 
 
-def live_transcription_to_speech_data(data: dict) -> List[stt.SpeechData]:
-    speech_data: List[stt.SpeechData] = []
+def live_transcription_to_speech_data(data: dict) -> list[stt.SpeechData]:
+    speech_data: list[stt.SpeechData] = []
 
     for result in data.get("results", []):
         start_time, end_time, is_eos = (

{livekit_plugins_speechmatics-0.0.2 → livekit_plugins_speechmatics-1.0.0.dev5}/livekit/plugins/speechmatics/types.py

@@ -1,7 +1,7 @@
 import ssl
 from dataclasses import asdict, dataclass, field
 from enum import Enum
-from typing import Any, Dict, Optional
+from typing import Any, Optional
 
 
 @dataclass
@@ -20,10 +20,10 @@ class TranscriptionConfig:
     diarization: Optional[str] = None
     """Indicates type of diarization to use, if any."""
 
-    additional_vocab: Optional[Dict] = None
+    additional_vocab: Optional[dict] = None
     """Additional vocabulary that is not part of the standard language."""
 
-    punctuation_overrides: Optional[Dict] = None
+    punctuation_overrides: Optional[dict] = None
     """Permitted puctuation marks for advanced punctuation."""
 
     enable_entities: Optional[bool] = None
@@ -46,11 +46,9 @@ class TranscriptionConfig:
     """Indicates if partials for transcription, where words are produced
     immediately, is enabled."""
 
-    def asdict(self) -> Dict[Any, Any]:
+    def asdict(self) -> dict[Any, Any]:
         """Returns model as a dict while excluding None values recursively."""
-        return asdict(
-            self, dict_factory=lambda x: {k: v for (k, v) in x if v is not None}
-        )
+        return asdict(self, dict_factory=lambda x: {k: v for (k, v) in x if v is not None})
 
 
 @dataclass

{livekit_plugins_speechmatics-0.0.2 → livekit_plugins_speechmatics-1.0.0.dev5}/livekit/plugins/speechmatics/utils.py

@@ -5,26 +5,20 @@ import aiohttp
 
 
 async def get_access_token(api_key: str) -> str:
-    mp_api_url = os.getenv(
-        "SPEECHMATICS_MANAGEMENT_PLATFORM_URL", "https://mp.speechmatics.com"
-    )
+    mp_api_url = os.getenv("SPEECHMATICS_MANAGEMENT_PLATFORM_URL", "https://mp.speechmatics.com")
     endpoint = f"{mp_api_url}/v1/api_keys"
     params = {"type": "rt", "sm-sdk": get_sdk_version()}
     json_body = {"ttl": 60}
     headers = {"Authorization": f"Bearer {api_key}", "Content-Type": "application/json"}
 
     async with aiohttp.ClientSession() as session:
-        async with session.post(
-            endpoint, params=params, json=json_body, headers=headers
-        ) as resp:
+        async with session.post(endpoint, params=params, json=json_body, headers=headers) as resp:
             if resp.status == 201:
                 try:
                     data = await resp.json()
                     return data["key_value"]
                 except (ValueError, KeyError) as e:
-                    raise Exception(
-                        f"Failed to parse Speechmatics access token response: {e}"
-                    )
+                    raise Exception(f"Failed to parse Speechmatics access token response: {e}")
             else:
                 error_message = await resp.text()
                 raise Exception(

{livekit_plugins_speechmatics-0.0.2 → livekit_plugins_speechmatics-1.0.0.dev5}/livekit/plugins/speechmatics/version.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = "0.0.2"
+__version__ = "1.0.0.dev5"

livekit_plugins_speechmatics-1.0.0.dev5/pyproject.toml

@@ -0,0 +1,39 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "livekit-plugins-speechmatics"
+dynamic = ["version"]
+description = "Agent Framework plugin for Speechmatics"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.9.0"
+authors = [{ name = "LiveKit", email = "support@livekit.io" }]
+keywords = ["webrtc", "realtime", "audio", "video", "livekit"]
+classifiers = [
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Topic :: Multimedia :: Sound/Audio",
+    "Topic :: Multimedia :: Video",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3 :: Only",
+]
+dependencies = ["livekit-agents>=1.0.0.dev5"]
+
+[project.urls]
+Documentation = "https://docs.livekit.io"
+Website = "https://livekit.io/"
+Source = "https://github.com/livekit/agents"
+
+[tool.hatch.version]
+path = "livekit/plugins/speechmatics/version.py"
+
+[tool.hatch.build.targets.wheel]
+packages = ["livekit"]
+
+[tool.hatch.build.targets.sdist]
+include = ["/livekit"]

livekit_plugins_speechmatics-0.0.2/livekit_plugins_speechmatics.egg-info/PKG-INFO

@@ -1,66 +0,0 @@
-Metadata-Version: 2.2
-Name: livekit-plugins-speechmatics
-Version: 0.0.2
-Summary: Agent Framework plugin for Speechmatics
-Home-page: https://github.com/livekit/agents
-License: Apache-2.0
-Project-URL: Documentation, https://docs.livekit.io
-Project-URL: Website, https://livekit.io/
-Project-URL: Source, https://github.com/livekit/agents
-Keywords: webrtc,realtime,audio,video,livekit
-Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Topic :: Multimedia :: Sound/Audio
-Classifier: Topic :: Multimedia :: Video
-Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
-Classifier: Programming Language :: Python :: 3 :: Only
-Requires-Python: >=3.9.0
-Description-Content-Type: text/markdown
-Requires-Dist: livekit-agents<1.0.0,>=0.12.16
-Dynamic: classifier
-Dynamic: description
-Dynamic: description-content-type
-Dynamic: home-page
-Dynamic: keywords
-Dynamic: license
-Dynamic: project-url
-Dynamic: requires-dist
-Dynamic: requires-python
-Dynamic: summary
-
-# LiveKit Plugins Speechmatics
-
-Agent Framework plugin for Speechmatics.
-
-## Installation
-
-```bash
-pip install livekit-plugins-speechmatics
-```
-
-Usage:
-
-```python
-agent = VoicePipelineAgent(
-    stt=speechmatics.STT(),
-    turn_detector=turn_detector.EOUModel(),
-    min_endpointing_delay=0.5,
-    max_endpointing_delay=5.0,
-    ...
-)
-```
-
-Note: The plugin was built with
-LiveKit's [end-of-turn detection feature](https://github.com/livekit/agents#in-house-phrase-endpointing-model) in mind,
-and it doesn't implement phrase endpointing. `AddTranscript` and `AddPartialTranscript` events are emitted as soon
-as they’re received from the Speechmatics STT engine. For the best user experience,
-we recommend running the agent with end-of-turn detection enabled (
-see [example](https://github.com/livekit-examples/voice-pipeline-agent-python/blob/main/agent.py)).
-
-## Pre-requisites
-
-You'll need to specify a Speechmatics API Key. It can be set as environment variable `SPEECHMATICS_API_KEY` or
-`.env.local` file.

livekit_plugins_speechmatics-0.0.2/livekit_plugins_speechmatics.egg-info/SOURCES.txt

@@ -1,14 +0,0 @@
-README.md
-setup.py
-livekit/plugins/speechmatics/__init__.py
-livekit/plugins/speechmatics/log.py
-livekit/plugins/speechmatics/py.typed
-livekit/plugins/speechmatics/stt.py
-livekit/plugins/speechmatics/types.py
-livekit/plugins/speechmatics/utils.py
-livekit/plugins/speechmatics/version.py
-livekit_plugins_speechmatics.egg-info/PKG-INFO
-livekit_plugins_speechmatics.egg-info/SOURCES.txt
-livekit_plugins_speechmatics.egg-info/dependency_links.txt
-livekit_plugins_speechmatics.egg-info/requires.txt
-livekit_plugins_speechmatics.egg-info/top_level.txt

livekit_plugins_speechmatics-0.0.2/livekit_plugins_speechmatics.egg-info/dependency_links.txt

@@ -1 +0,0 @@
-

livekit_plugins_speechmatics-0.0.2/livekit_plugins_speechmatics.egg-info/requires.txt

@@ -1 +0,0 @@
-livekit-agents<1.0.0,>=0.12.16

livekit_plugins_speechmatics-0.0.2/livekit_plugins_speechmatics.egg-info/top_level.txt

@@ -1 +0,0 @@
-livekit

livekit_plugins_speechmatics-0.0.2/setup.cfg

@@ -1,4 +0,0 @@
-[egg_info]
-tag_build = 
-tag_date = 0
-

livekit_plugins_speechmatics-0.0.2/setup.py

@@ -1,58 +0,0 @@
-# Licensed under the Apache License, Version 2.0 (the "License");
-# you may not use this file except in compliance with the License.
-# You may obtain a copy of the License at
-#
-#     http://www.apache.org/licenses/LICENSE-2.0
-#
-# Unless required by applicable law or agreed to in writing, software
-# distributed under the License is distributed on an "AS IS" BASIS,
-# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
-# See the License for the specific language governing permissions and
-# limitations under the License.
-
-import os
-import pathlib
-
-import setuptools.command.build_py
-
-here = pathlib.Path(__file__).parent.resolve()
-about = {}
-with open(
-    os.path.join(here, "livekit", "plugins", "speechmatics", "version.py"), "r"
-) as f:
-    exec(f.read(), about)
-
-
-setuptools.setup(
-    name="livekit-plugins-speechmatics",
-    version=about["__version__"],
-    description="Agent Framework plugin for Speechmatics",
-    long_description=(here / "README.md").read_text(encoding="utf-8"),
-    long_description_content_type="text/markdown",
-    url="https://github.com/livekit/agents",
-    cmdclass={},
-    classifiers=[
-        "Intended Audience :: Developers",
-        "License :: OSI Approved :: Apache Software License",
-        "Topic :: Multimedia :: Sound/Audio",
-        "Topic :: Multimedia :: Video",
-        "Topic :: Scientific/Engineering :: Artificial Intelligence",
-        "Programming Language :: Python :: 3",
-        "Programming Language :: Python :: 3.9",
-        "Programming Language :: Python :: 3.10",
-        "Programming Language :: Python :: 3 :: Only",
-    ],
-    keywords=["webrtc", "realtime", "audio", "video", "livekit"],
-    license="Apache-2.0",
-    packages=setuptools.find_namespace_packages(include=["livekit.*"]),
-    python_requires=">=3.9.0",
-    install_requires=[
-        "livekit-agents>=0.12.16,<1.0.0",
-    ],
-    package_data={},
-    project_urls={
-        "Documentation": "https://docs.livekit.io",
-        "Website": "https://livekit.io/",
-        "Source": "https://github.com/livekit/agents",
-    },
-)