speechcortex-sdk 0.1.0__tar.gz

speechcortex_sdk-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2024 Zeus
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

speechcortex_sdk-0.1.0/MANIFEST.in

@@ -0,0 +1,8 @@
+include README.md
+include LICENSE
+include requirements.txt
+include requirements-dev.txt
+include pyproject.toml
+recursive-include zeus *.py
+recursive-exclude * __pycache__
+recursive-exclude * *.py[co]

speechcortex_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,218 @@
+Metadata-Version: 2.4
+Name: speechcortex-sdk
+Version: 0.1.0
+Summary: The official Python SDK for SpeechCortex ASR platform.
+Home-page: https://github.com/skanda-observeai/zeus-sdk-py
+Author: SpeechCortex Team
+Author-email: SpeechCortex Team <team@speechcortex.com>
+License: MIT
+Project-URL: Homepage, https://github.com/skanda-observeai/zeus-sdk-py
+Project-URL: Bug Tracker, https://github.com/skanda-observeai/zeus-sdk-py/issues
+Project-URL: Source Code, https://github.com/skanda-observeai/zeus-sdk-py
+Project-URL: Documentation, https://github.com/skanda-observeai/zeus-sdk-py#readme
+Keywords: speechcortex,asr,speech-to-text,speech recognition
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx>=0.25.2
+Requires-Dist: websockets>=12.0
+Requires-Dist: dataclasses-json>=0.6.3
+Requires-Dist: typing-extensions>=4.9.0
+Requires-Dist: aiohttp>=3.9.1
+Requires-Dist: aiofiles>=23.2.1
+Requires-Dist: aenum>=3.1.0
+Requires-Dist: deprecation>=2.1.0
+Dynamic: author
+Dynamic: home-page
+Dynamic: license-file
+Dynamic: requires-python
+
+# SpeechCortex Python SDK
+
+[![CI](https://github.com/skanda-observeai/zeus-sdk-py/actions/workflows/ci.yml/badge.svg)](https://github.com/skanda-observeai/zeus-sdk-py/actions/workflows/ci.yml)
+[![PyPI version](https://badge.fury.io/py/speechcortex-sdk.svg)](https://badge.fury.io/py/speechcortex-sdk)
+[![Python Versions](https://img.shields.io/pypi/pyversions/speechcortex-sdk.svg)](https://pypi.org/project/speechcortex-sdk/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Official Python SDK for SpeechCortex ASR (Automatic Speech Recognition) platform.
+
+## Features
+
+- **Real-time Speech Recognition**: WebSocket-based streaming ASR
+- **Pre-recorded Transcription**: REST API for batch processing (coming soon)
+- **Easy Integration**: Simple, intuitive API
+- **Async Support**: Full async/await support for modern Python applications
+
+## Requirements
+
+- Python 3.10 or higher
+
+## Installation
+
+```bash
+pip install "git+https://github.com/skanda-observeai/zeus-sdk-py.git@package_init"
+```
+
+```bash
+export SPEECHCORTEX_API_KEY=your_api_key_here
+export SPEECHCORTEX_HOST=wss://api.speechcortex.com
+```
+
+## Quick Start
+
+### Real-time Transcription
+
+```python
+from speechcortex import SpeechCortexClient, LiveTranscriptionEvents, LiveOptions
+
+# Initialize the client
+speechcortex = SpeechCortexClient(api_key="your_api_key_here")
+
+# Get WebSocket connection
+connection = speechcortex.listen.websocket.v("1")
+
+# Set up event handlers
+def on_message(self, result, **kwargs):
+    sentence = result.channel.alternatives[0].transcript
+    if result.is_final:
+        print(f"Final: {sentence}")
+    else:
+        print(f"Interim: {sentence}")
+
+def on_error(self, error, **kwargs):
+    print(f"Error: {error}")
+
+# Register event handlers
+connection.on(LiveTranscriptionEvents.Transcript, on_message)
+connection.on(LiveTranscriptionEvents.Error, on_error)
+
+# Configure options
+options = LiveOptions(
+    model="zeus-v1",
+    language="en-US",
+    smart_format=True,
+)
+
+# Start the connection
+connection.start(options)
+
+# Send audio data
+connection.send(audio_data)
+
+# Close when done
+connection.finish()
+```
+
+### Using with Microphone
+
+```python
+from speechcortex import SpeechCortexClient, LiveTranscriptionEvents, LiveOptions, Microphone
+
+speechcortex = SpeechCortexClient()
+connection = speechcortex.listen.websocket.v("1")
+
+# Set up event handlers...
+connection.on(LiveTranscriptionEvents.Transcript, on_message)
+
+# Start connection
+options = LiveOptions(model="zeus-v1", smart_format=True)
+connection.start(options)
+
+# Use microphone helper
+microphone = Microphone(connection.send)
+microphone.start()
+
+# Microphone will stream audio automatically
+# Press Ctrl+C to stop
+
+microphone.finish()
+connection.finish()
+```
+
+## Configuration
+
+### API Key
+
+Set your API key via environment variable:
+
+```bash
+export SPEECHCORTEX_API_KEY=your_api_key_here
+```
+
+Or pass it directly:
+
+```python
+speechcortex = SpeechCortexClient(api_key="your_api_key_here")
+```
+
+### Custom Endpoints
+
+```python
+from speechcortex import SpeechCortexClient, SpeechCortexClientOptions
+
+config = SpeechCortexClientOptions(
+    api_key="your_api_key",
+    url="https://custom-api.speechcortex.com"
+)
+speechcortex = SpeechCortexClient(config=config)
+```
+
+## Features
+
+### Real-time Transcription Options
+
+- `model`: ASR model to use (e.g., "zeus-v1")
+- `language`: Language code (e.g., "en-US")
+- `smart_format`: Enable smart formatting
+- `punctuate`: Enable punctuation
+- `interim_results`: Receive interim results
+- `utterance_end_ms`: Utterance end timeout in milliseconds
+- `vad_events`: Enable voice activity detection events
+
+### Events
+
+- `Open`: Connection opened
+- `Transcript`: Transcription result received
+- `Metadata`: Metadata received
+- `SpeechStarted`: Speech detected
+- `UtteranceEnd`: End of utterance detected
+- `Close`: Connection closed
+- `Error`: Error occurred
+- `Unhandled`: Unhandled message received
+
+## Development
+
+### Setup Development Environment
+
+```bash
+# Clone the repository
+git clone https://github.com/speechcortex/speechcortex-sdk.git
+cd speechcortex-sdk
+
+# Install dependencies
+pip install -r requirements-dev.txt
+
+# Run tests
+pytest
+
+# Run linting
+pylint speechcortex/
+
+# Format code
+black speechcortex/
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Support
+
+For issues, questions, or contributions, please visit our [GitHub repository](https://github.com/speechcortex/speechcortex-sdk).

speechcortex_sdk-0.1.0/README.md

@@ -0,0 +1,183 @@
+# SpeechCortex Python SDK
+
+[![CI](https://github.com/skanda-observeai/zeus-sdk-py/actions/workflows/ci.yml/badge.svg)](https://github.com/skanda-observeai/zeus-sdk-py/actions/workflows/ci.yml)
+[![PyPI version](https://badge.fury.io/py/speechcortex-sdk.svg)](https://badge.fury.io/py/speechcortex-sdk)
+[![Python Versions](https://img.shields.io/pypi/pyversions/speechcortex-sdk.svg)](https://pypi.org/project/speechcortex-sdk/)
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+[![Code style: black](https://img.shields.io/badge/code%20style-black-000000.svg)](https://github.com/psf/black)
+
+Official Python SDK for SpeechCortex ASR (Automatic Speech Recognition) platform.
+
+## Features
+
+- **Real-time Speech Recognition**: WebSocket-based streaming ASR
+- **Pre-recorded Transcription**: REST API for batch processing (coming soon)
+- **Easy Integration**: Simple, intuitive API
+- **Async Support**: Full async/await support for modern Python applications
+
+## Requirements
+
+- Python 3.10 or higher
+
+## Installation
+
+```bash
+pip install "git+https://github.com/skanda-observeai/zeus-sdk-py.git@package_init"
+```
+
+```bash
+export SPEECHCORTEX_API_KEY=your_api_key_here
+export SPEECHCORTEX_HOST=wss://api.speechcortex.com
+```
+
+## Quick Start
+
+### Real-time Transcription
+
+```python
+from speechcortex import SpeechCortexClient, LiveTranscriptionEvents, LiveOptions
+
+# Initialize the client
+speechcortex = SpeechCortexClient(api_key="your_api_key_here")
+
+# Get WebSocket connection
+connection = speechcortex.listen.websocket.v("1")
+
+# Set up event handlers
+def on_message(self, result, **kwargs):
+    sentence = result.channel.alternatives[0].transcript
+    if result.is_final:
+        print(f"Final: {sentence}")
+    else:
+        print(f"Interim: {sentence}")
+
+def on_error(self, error, **kwargs):
+    print(f"Error: {error}")
+
+# Register event handlers
+connection.on(LiveTranscriptionEvents.Transcript, on_message)
+connection.on(LiveTranscriptionEvents.Error, on_error)
+
+# Configure options
+options = LiveOptions(
+    model="zeus-v1",
+    language="en-US",
+    smart_format=True,
+)
+
+# Start the connection
+connection.start(options)
+
+# Send audio data
+connection.send(audio_data)
+
+# Close when done
+connection.finish()
+```
+
+### Using with Microphone
+
+```python
+from speechcortex import SpeechCortexClient, LiveTranscriptionEvents, LiveOptions, Microphone
+
+speechcortex = SpeechCortexClient()
+connection = speechcortex.listen.websocket.v("1")
+
+# Set up event handlers...
+connection.on(LiveTranscriptionEvents.Transcript, on_message)
+
+# Start connection
+options = LiveOptions(model="zeus-v1", smart_format=True)
+connection.start(options)
+
+# Use microphone helper
+microphone = Microphone(connection.send)
+microphone.start()
+
+# Microphone will stream audio automatically
+# Press Ctrl+C to stop
+
+microphone.finish()
+connection.finish()
+```
+
+## Configuration
+
+### API Key
+
+Set your API key via environment variable:
+
+```bash
+export SPEECHCORTEX_API_KEY=your_api_key_here
+```
+
+Or pass it directly:
+
+```python
+speechcortex = SpeechCortexClient(api_key="your_api_key_here")
+```
+
+### Custom Endpoints
+
+```python
+from speechcortex import SpeechCortexClient, SpeechCortexClientOptions
+
+config = SpeechCortexClientOptions(
+    api_key="your_api_key",
+    url="https://custom-api.speechcortex.com"
+)
+speechcortex = SpeechCortexClient(config=config)
+```
+
+## Features
+
+### Real-time Transcription Options
+
+- `model`: ASR model to use (e.g., "zeus-v1")
+- `language`: Language code (e.g., "en-US")
+- `smart_format`: Enable smart formatting
+- `punctuate`: Enable punctuation
+- `interim_results`: Receive interim results
+- `utterance_end_ms`: Utterance end timeout in milliseconds
+- `vad_events`: Enable voice activity detection events
+
+### Events
+
+- `Open`: Connection opened
+- `Transcript`: Transcription result received
+- `Metadata`: Metadata received
+- `SpeechStarted`: Speech detected
+- `UtteranceEnd`: End of utterance detected
+- `Close`: Connection closed
+- `Error`: Error occurred
+- `Unhandled`: Unhandled message received
+
+## Development
+
+### Setup Development Environment
+
+```bash
+# Clone the repository
+git clone https://github.com/speechcortex/speechcortex-sdk.git
+cd speechcortex-sdk
+
+# Install dependencies
+pip install -r requirements-dev.txt
+
+# Run tests
+pytest
+
+# Run linting
+pylint speechcortex/
+
+# Format code
+black speechcortex/
+```
+
+## License
+
+MIT License - see [LICENSE](LICENSE) file for details.
+
+## Support
+
+For issues, questions, or contributions, please visit our [GitHub repository](https://github.com/speechcortex/speechcortex-sdk).

speechcortex_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,102 @@
+######
+# general configuration
+######
+[build-system]
+requires = ["setuptools>=61.0", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "speechcortex-sdk"
+version = "0.1.0"
+description = "The official Python SDK for SpeechCortex ASR platform."
+readme = "README.md"
+requires-python = ">=3.10"
+license = {text = "MIT"}
+authors = [
+    {name = "SpeechCortex Team", email = "team@speechcortex.com"}
+]
+keywords = ["speechcortex", "asr", "speech-to-text", "speech recognition"]
+classifiers = [
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: MIT License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+]
+dependencies = [
+    "httpx>=0.25.2",
+    "websockets>=12.0",
+    "dataclasses-json>=0.6.3",
+    "typing-extensions>=4.9.0",
+    "aiohttp>=3.9.1",
+    "aiofiles>=23.2.1",
+    "aenum>=3.1.0",
+    "deprecation>=2.1.0",
+]
+
+[project.urls]
+"Homepage" = "https://github.com/skanda-observeai/zeus-sdk-py"
+"Bug Tracker" = "https://github.com/skanda-observeai/zeus-sdk-py/issues"
+"Source Code" = "https://github.com/skanda-observeai/zeus-sdk-py"
+"Documentation" = "https://github.com/skanda-observeai/zeus-sdk-py#readme"
+
+######
+# poetry configuration (optional)
+######
+[tool.poetry]
+name = "speechcortex-sdk"
+version = "0.1.0"
+description = "The official Python SDK for SpeechCortex ASR platform."
+authors = ["SpeechCortex Team <team@speechcortex.com>"]
+license = "MIT"
+readme = "README.md"
+
+[tool.poetry.dependencies]
+python = "^3.10"
+httpx = "^0.25.2"
+websockets = ">=12.0"
+typing-extensions = "^4.9.0"
+dataclasses-json = "^0.6.3"
+aiohttp = "^3.9.1"
+aiofiles = "^23.2.1"
+aenum = "^3.1.0"
+deprecation = "^2.1.0"
+
+[tool.poetry.group.dev.dependencies]
+black = "^24.0"
+pylint = "^3.0"
+mypy = "^1.0"
+pytest = "^7.4.3"
+pytest-asyncio = "^0.21.1"
+pytest-cov = "^4.1.0"
+types-aiofiles = "^23.2.0"
+
+######
+# black configuration
+######
+[tool.black]
+line-length = 88
+target-version = ['py310']
+include = '\.pyi?$'
+
+######
+# mypy configuration
+######
+[tool.mypy]
+python_version = "3.10"
+warn_return_any = true
+warn_unused_configs = true
+disallow_untyped_defs = false
+ignore_missing_imports = true
+
+######
+# pytest configuration
+######
+[tool.pytest.ini_options]
+minversion = "7.0"
+asyncio_mode = "auto"
+testpaths = ["tests"]
+python_files = ["test_*.py", "*_test.py"]
+python_classes = ["Test*"]
+python_functions = ["test_*"]

speechcortex_sdk-0.1.0/requirements-dev.txt

@@ -0,0 +1,10 @@
+-r requirements.txt
+black>=24.0
+pylint>=3.0
+mypy>=1.0
+pytest>=7.4.3
+pytest-asyncio>=0.21.1
+pytest-cov>=4.1.0
+types-aiofiles>=23.2.0
+python-dotenv>=1.0.0
+pyaudio>=0.2.14

speechcortex_sdk-0.1.0/requirements.txt

@@ -0,0 +1,8 @@
+httpx>=0.25.2
+websockets>=12.0
+dataclasses-json>=0.6.3
+typing-extensions>=4.9.0
+aiohttp>=3.9.1
+aiofiles>=23.2.1
+aenum>=3.1.0
+deprecation>=2.1.0

speechcortex_sdk-0.1.0/setup.cfg

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

speechcortex_sdk-0.1.0/setup.py

@@ -0,0 +1,52 @@
+# Copyright 2024 SpeechCortex SDK contributors. All Rights Reserved.
+# Use of this source code is governed by a MIT license that can be found in the LICENSE file.
+# SPDX-License-Identifier: MIT
+
+from setuptools import setup, find_packages
+import sys
+
+if sys.version_info < (3, 10):
+    sys.exit("Sorry, Python < 3.10 is not supported")
+
+with open("README.md", "r", encoding="utf-8") as fh:
+    LONG_DESCRIPTION = fh.read()
+
+DESCRIPTION = "The official Python SDK for SpeechCortex ASR platform."
+
+setup(
+    name="speechcortex-sdk",
+    version="0.1.0",
+    author="SpeechCortex Team",
+    author_email="team@speechcortex.com",
+    url="https://github.com/skanda-observeai/zeus-sdk-py",
+    project_urls={
+        "Bug Tracker": "https://github.com/skanda-observeai/zeus-sdk-py/issues",
+        "Source Code": "https://github.com/skanda-observeai/zeus-sdk-py",
+        "Documentation": "https://github.com/skanda-observeai/zeus-sdk-py#readme",
+    },
+    description=DESCRIPTION,
+    long_description=LONG_DESCRIPTION,
+    long_description_content_type="text/markdown",
+    license="MIT",
+    packages=find_packages(exclude=["tests", "examples"]),
+    install_requires=[
+        "httpx>=0.25.2",
+        "websockets>=12.0",
+        "dataclasses-json>=0.6.3",
+        "typing_extensions>=4.9.0",
+        "aiohttp>=3.9.1",
+        "aiofiles>=23.2.1",
+        "aenum>=3.1.0",
+        "deprecation>=2.1.0",
+    ],
+    keywords=["speechcortex", "asr", "speech-to-text", "speech recognition"],
+    classifiers=[
+        "Intended Audience :: Developers",
+        "License :: OSI Approved :: MIT License",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.10",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+    ],
+    python_requires=">=3.10",
+)