speechmatics-rt 0.1.0__tar.gz

speechmatics_rt-0.1.0/PKG-INFO

@@ -0,0 +1,103 @@
+Metadata-Version: 2.4
+Name: speechmatics-rt
+Version: 0.1.0
+Summary: Speechmatics Real-Time API Client
+Author-email: Speechmatics <support@speechmatics.com>
+License-Expression: MIT
+Project-URL: homepage, https://github.com/speechmatics/speechmatics-python-sdk
+Project-URL: documentation, https://docs.speechmatics.com/
+Project-URL: repository, https://github.com/speechmatics/speechmatics-python-sdk
+Project-URL: issues, https://github.com/speechmatics/speechmatics-python-sdk/issues
+Keywords: speechmatics,speech-to-text,real-time,transcription,websocket
+Classifier: Development Status :: 4 - Beta
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Operating System :: OS Independent
+Classifier: Topic :: Multimedia :: Sound/Audio :: Speech
+Classifier: Topic :: Software Development :: Libraries :: Python Modules
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+Requires-Dist: websockets>=10.0
+Requires-Dist: structlog
+Provides-Extra: jwt
+Requires-Dist: aiohttp; extra == "jwt"
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-asyncio; extra == "dev"
+Requires-Dist: pytest-cov; extra == "dev"
+Requires-Dist: pytest-mock; extra == "dev"
+Requires-Dist: build; extra == "dev"
+
+# Speechmatics Real-Time API Client
+
+Async Python client for the Speechmatics Real-Time API.
+
+## Features
+
+- **Async-first design** with synchronous wrappers for compatibility
+- **Comprehensive error handling** with detailed error messages
+- **Type hints throughout** for excellent IDE support and code safety
+- **Environment variable support** for secure credential management
+- **Event-driven architecture** for real-time transcript processing
+- **Simple connection management** with clear error reporting
+
+## Installation
+
+```bash
+pip install speechmatics-rt
+
+```
+## Quick Start
+
+```python
+import asyncio
+from speechmatics.rt import AsyncClient, ServerMessageType
+
+
+async def main():
+    # Create a client using environment variable SPEECHMATICS_API_KEY
+    async with AsyncClient() as client:
+        # Register event handlers
+        @client.on(ServerMessageType.ADD_TRANSCRIPT)
+        def handle_final_transcript(msg):
+            print(f"Final: {msg['metadata']['transcript']}")
+
+        # Transcribe audio file
+        with open("audio.wav", "rb") as audio_file:
+            await client.transcribe(audio_file)
+
+# Run the async function
+asyncio.run(main())
+```
+
+## Logging
+
+The client supports logging with job id tracing for debugging. To increase logging verbosity, set `DEBUG` level in your example code:
+
+```python
+import logging
+import sys
+
+logging.basicConfig(
+    level=logging.DEBUG,
+    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
+    handlers=[
+        logging.StreamHandler(sys.stdout)
+    ]
+)
+```
+
+### Environment Variables
+
+The client supports the following environment variables:
+
+- `SPEECHMATICS_API_KEY`: Your Speechmatics API key
+- `SPEECHMATICS_RT_URL`: Custom API endpoint URL (optional)

speechmatics_rt-0.1.0/README.md

@@ -0,0 +1,65 @@
+# Speechmatics Real-Time API Client
+
+Async Python client for the Speechmatics Real-Time API.
+
+## Features
+
+- **Async-first design** with synchronous wrappers for compatibility
+- **Comprehensive error handling** with detailed error messages
+- **Type hints throughout** for excellent IDE support and code safety
+- **Environment variable support** for secure credential management
+- **Event-driven architecture** for real-time transcript processing
+- **Simple connection management** with clear error reporting
+
+## Installation
+
+```bash
+pip install speechmatics-rt
+
+```
+## Quick Start
+
+```python
+import asyncio
+from speechmatics.rt import AsyncClient, ServerMessageType
+
+
+async def main():
+    # Create a client using environment variable SPEECHMATICS_API_KEY
+    async with AsyncClient() as client:
+        # Register event handlers
+        @client.on(ServerMessageType.ADD_TRANSCRIPT)
+        def handle_final_transcript(msg):
+            print(f"Final: {msg['metadata']['transcript']}")
+
+        # Transcribe audio file
+        with open("audio.wav", "rb") as audio_file:
+            await client.transcribe(audio_file)
+
+# Run the async function
+asyncio.run(main())
+```
+
+## Logging
+
+The client supports logging with job id tracing for debugging. To increase logging verbosity, set `DEBUG` level in your example code:
+
+```python
+import logging
+import sys
+
+logging.basicConfig(
+    level=logging.DEBUG,
+    format='%(asctime)s - %(name)s - %(levelname)s - %(message)s',
+    handlers=[
+        logging.StreamHandler(sys.stdout)
+    ]
+)
+```
+
+### Environment Variables
+
+The client supports the following environment variables:
+
+- `SPEECHMATICS_API_KEY`: Your Speechmatics API key
+- `SPEECHMATICS_RT_URL`: Custom API endpoint URL (optional)

speechmatics_rt-0.1.0/pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["setuptools>=61.0.0"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "speechmatics-rt"
+dynamic = ["version"]
+description = "Speechmatics Real-Time API Client"
+readme = "README.md"
+authors = [{ name = "Speechmatics", email = "support@speechmatics.com" }]
+license = "MIT"
+requires-python = ">=3.9"
+dependencies = ["websockets>=10.0", "structlog"]
+classifiers = [
+    "Development Status :: 4 - Beta",
+    "Intended Audience :: Developers",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.9",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Operating System :: OS Independent",
+    "Topic :: Multimedia :: Sound/Audio :: Speech",
+    "Topic :: Software Development :: Libraries :: Python Modules",
+]
+keywords = [
+    "speechmatics",
+    "speech-to-text",
+    "real-time",
+    "transcription",
+    "websocket",
+]
+
+[project.optional-dependencies]
+jwt = ["aiohttp"]
+dev = [
+    "black",
+    "ruff",
+    "mypy",
+    "pre-commit",
+    "pytest",
+    "pytest-asyncio",
+    "pytest-cov",
+    "pytest-mock",
+    "build",
+]
+
+[project.urls]
+homepage = "https://github.com/speechmatics/speechmatics-python-sdk"
+documentation = "https://docs.speechmatics.com/"
+repository = "https://github.com/speechmatics/speechmatics-python-sdk"
+issues = "https://github.com/speechmatics/speechmatics-python-sdk/issues"
+
+[tool.setuptools.dynamic]
+version = { attr = "speechmatics.rt.__version__" }
+
+[tool.setuptools.packages.find]
+where = ["."]

speechmatics_rt-0.1.0/setup.cfg

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

speechmatics_rt-0.1.0/speechmatics/rt/__init__.py

@@ -0,0 +1,51 @@
+__version__ = "0.1.0"
+
+from ._async_client import AsyncClient
+from ._events import EventEmitter
+from ._exceptions import AudioError
+from ._exceptions import AuthenticationError
+from ._exceptions import ConfigurationError
+from ._exceptions import ConnectionError
+from ._exceptions import EndOfTranscriptError
+from ._exceptions import ForceEndSession
+from ._exceptions import SessionError
+from ._exceptions import TimeoutError
+from ._exceptions import TranscriptionError
+from ._exceptions import TransportError
+from ._models import AudioEncoding
+from ._models import AudioEventsConfig
+from ._models import AudioFormat
+from ._models import ClientMessageType
+from ._models import ConnectionConfig
+from ._models import OperatingPoint
+from ._models import ServerMessageType
+from ._models import SessionInfo
+from ._models import TranscriptionConfig
+from ._models import TranscriptResult
+from ._models import TranslationConfig
+
+__all__ = [
+    "AsyncClient",
+    "EventEmitter",
+    "AudioFormat",
+    "AudioEventsConfig",
+    "TranscriptionConfig",
+    "TranslationConfig",
+    "ConnectionConfig",
+    "SessionInfo",
+    "TranscriptResult",
+    "AudioEncoding",
+    "ClientMessageType",
+    "ServerMessageType",
+    "OperatingPoint",
+    "ConfigurationError",
+    "AuthenticationError",
+    "ConnectionError",
+    "TransportError",
+    "TranscriptionError",
+    "AudioError",
+    "SessionError",
+    "TimeoutError",
+    "EndOfTranscriptError",
+    "ForceEndSession",
+]