livekit-plugins-resemble 0.1.0rc1__tar.gz → 0.1.2__tar.gz

{livekit_plugins_resemble-0.1.0rc1 → livekit_plugins_resemble-0.1.2}/PKG-INFO

@@ -1,25 +1,33 @@
 Metadata-Version: 2.4
 Name: livekit-plugins-resemble
-Version: 0.1.0rc1
+Version: 0.1.2
 Summary: LiveKit Agents Plugin for Resemble AI
+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
-Author-email: LiveKit <hello@livekit.io>
-License-Expression: Apache-2.0
-Keywords: audio,livekit,realtime,video,webrtc
+Keywords: webrtc,realtime,audio,video,livekit,resemble,tts
 Classifier: Intended Audience :: Developers
-Classifier: License :: OSI Approved :: Apache Software License
-Classifier: Programming Language :: Python :: 3
-Classifier: Programming Language :: Python :: 3 :: Only
-Classifier: Programming Language :: Python :: 3.9
-Classifier: Programming Language :: Python :: 3.10
 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.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
 Requires-Python: >=3.9.0
-Requires-Dist: livekit-agents>=1.0.0.rc7
 Description-Content-Type: text/markdown
+Requires-Dist: livekit-agents[codecs]>=0.12.20
+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 Resemble
 
@@ -138,4 +146,4 @@ This plugin uses two different approaches to generate speech:
 1. **One-off Synthesis** - Uses Resemble's REST API for simple text-to-speech conversion
 2. **Streaming Synthesis** - Uses Resemble's WebSocket API for real-time streaming synthesis
 
-The WebSocket streaming API is only available for Resemble AI Business plan users. 
+The WebSocket streaming API is only available for Resemble AI Business plan users. 

{livekit_plugins_resemble-0.1.0rc1 → livekit_plugins_resemble-0.1.2}/livekit/plugins/resemble/tts.py

@@ -20,9 +20,9 @@ import json
 import os
 import weakref
 from dataclasses import dataclass
+from typing import Optional
 
 import aiohttp
-
 from livekit.agents import (
     APIConnectionError,
     APIConnectOptions,
@@ -83,13 +83,14 @@ class TTS(tts.TTS):
         api_key = api_key or os.environ.get("RESEMBLE_API_KEY")
         if not api_key:
             raise ValueError(
-                "Resemble API key is required, either as argument or set RESEMBLE_API_KEY"
-                " environment variable"
+                "Resemble API key is required, either as argument or set RESEMBLE_API_KEY environment variable"
             )
         self._api_key = api_key
 
         if tokenizer is None:
-            tokenizer = tokenize.basic.SentenceTokenizer(min_sentence_len=BUFFERED_WORDS_COUNT)
+            tokenizer = tokenize.basic.SentenceTokenizer(
+                min_sentence_len=BUFFERED_WORDS_COUNT
+            )
 
         if voice_uuid is None:
             voice_uuid = DEFAULT_VOICE_UUID
@@ -150,7 +151,7 @@ class TTS(tts.TTS):
         self,
         text: str,
         *,
-        conn_options: APIConnectOptions | None = None,
+        conn_options: Optional[APIConnectOptions] = None,
     ) -> ChunkedStream:
         return ChunkedStream(
             tts=self,
@@ -161,7 +162,9 @@ class TTS(tts.TTS):
             session=self._ensure_session(),
         )
 
-    def stream(self, *, conn_options: APIConnectOptions | None = None) -> SynthesizeStream:
+    def stream(
+        self, *, conn_options: Optional[APIConnectOptions] = None
+    ) -> SynthesizeStream:
         stream = SynthesizeStream(
             tts=self,
             pool=self._pool,
@@ -212,6 +215,7 @@ class ChunkedStream(tts.ChunkedStream):
             "sample_rate": self._opts.sample_rate,
             "precision": "PCM_16",
         }
+
         decoder = utils.codecs.AudioStreamDecoder(
             sample_rate=self._opts.sample_rate,
             num_channels=NUM_CHANNELS,

{livekit_plugins_resemble-0.1.0rc1 → livekit_plugins_resemble-0.1.2}/livekit/plugins/resemble/version.py

@@ -12,4 +12,4 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-__version__ = '0.1.0.rc1'
+__version__ = "0.1.2"

livekit_plugins_resemble-0.1.2/livekit_plugins_resemble.egg-info/PKG-INFO

@@ -0,0 +1,149 @@
+Metadata-Version: 2.4
+Name: livekit-plugins-resemble
+Version: 0.1.2
+Summary: LiveKit Agents Plugin for Resemble AI
+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,resemble,tts
+Classifier: Intended Audience :: Developers
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3 :: Only
+Requires-Python: >=3.9.0
+Description-Content-Type: text/markdown
+Requires-Dist: livekit-agents[codecs]>=0.12.20
+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 Resemble
+
+Agent Framework plugin for voice synthesis with the [Resemble AI](https://www.resemble.ai/) API, using both their REST API and WebSocket streaming interface.
+
+## Installation
+
+```bash
+pip install livekit-plugins-resemble
+```
+
+## Pre-requisites
+
+You'll need an API key from Resemble AI. It can be set as an environment variable: `RESEMBLE_API_KEY`
+
+Additionally, you'll need the voice UUID from your Resemble AI account.
+
+## Examples
+
+### Recommended
+
+```python
+import asyncio
+from livekit.plugins.resemble import TTS
+
+async def run_tts_example():
+    # Use TTS with async context manager for automatic resource cleanup
+    async with TTS(
+        api_key="your_api_key",  # or set RESEMBLE_API_KEY environment variable
+        voice_uuid="your_voice_uuid",
+        # Optional parameters
+        sample_rate=44100,  # Sample rate in Hz (default: 44100)
+        precision="PCM_16",  # Audio precision (PCM_32, PCM_24, PCM_16, MULAW)
+        output_format="wav",  # Output format (wav or mp3)
+    ) as tts:
+        # One-off synthesis (uses REST API)
+        audio_stream = tts.synthesize("Hello, world!")
+        
+        # Process chunks as they arrive
+        async for chunk in audio_stream:
+            # Audio data is in the 'frame.data' attribute of SynthesizedAudio objects
+            audio_data = chunk.frame.data
+            print(f"Received chunk: {len(audio_data)} bytes")
+        
+        # Alternative: collect all audio at once into a single AudioFrame
+        audio_stream = tts.synthesize("Another example sentence.")
+        audio_frame = await audio_stream.collect()
+        print(f"Collected complete audio: {len(audio_frame.data)} bytes")
+        
+        # Real-time streaming synthesis (uses WebSocket API)
+        # Only available for Business plan users in Resemble AI
+        stream = tts.stream()
+        await stream.synthesize_text("Hello, world!")
+        
+
+
+# Run the example
+asyncio.run(run_tts_example())
+```
+
+### Alternative: Manual Resource Management
+
+If you prefer to manage resources manually, make sure to properly clean up:
+
+```python
+import asyncio
+from livekit.plugins.resemble import TTS
+
+async def run_tts_example():
+    # Initialize TTS with your credentials
+    tts = TTS(
+        api_key="your_api_key", 
+        voice_uuid="your_voice_uuid",
+    )
+
+    try:
+        # TTS operations
+        audio_stream = tts.synthesize("Hello, world!")
+        async for chunk in audio_stream:
+            # Access audio data correctly
+            process_audio(chunk.frame.data)
+    finally:
+        # Always clean up resources when done
+        await tts.aclose()
+
+# Run the example
+asyncio.run(run_tts_example())
+```
+
+### Resource Management
+
+When using this plugin outside of the LiveKit agent framework, it's important to properly manage the TTS instance lifecycle:
+
+1. **Preferred method**: Use the async context manager pattern (`async with TTS(...) as tts:`)
+2. If managing manually, always call `await tts.aclose()` in a finally block
+3. If you prefer to provide your own HTTP session, you can pass it using the `http_session` parameter:
+
+```python
+import aiohttp
+
+async def with_custom_session():
+    async with aiohttp.ClientSession() as session:
+        async with TTS(
+            api_key="your_api_key",
+            voice_uuid="your_voice_uuid",
+            http_session=session
+        ) as tts:
+            # Use TTS...
+            # No need to manually close anything - context managers handle it all
+```
+
+## Implementation Details
+
+This plugin uses two different approaches to generate speech:
+
+1. **One-off Synthesis** - Uses Resemble's REST API for simple text-to-speech conversion
+2. **Streaming Synthesis** - Uses Resemble's WebSocket API for real-time streaming synthesis
+
+The WebSocket streaming API is only available for Resemble AI Business plan users. 

livekit_plugins_resemble-0.1.2/livekit_plugins_resemble.egg-info/SOURCES.txt

@@ -0,0 +1,14 @@
+README.md
+pyproject.toml
+setup.py
+livekit/plugins/resemble/__init__.py
+livekit/plugins/resemble/log.py
+livekit/plugins/resemble/models.py
+livekit/plugins/resemble/py.typed
+livekit/plugins/resemble/tts.py
+livekit/plugins/resemble/version.py
+livekit_plugins_resemble.egg-info/PKG-INFO
+livekit_plugins_resemble.egg-info/SOURCES.txt
+livekit_plugins_resemble.egg-info/dependency_links.txt
+livekit_plugins_resemble.egg-info/requires.txt
+livekit_plugins_resemble.egg-info/top_level.txt

livekit_plugins_resemble-0.1.2/livekit_plugins_resemble.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

livekit_plugins_resemble-0.1.2/livekit_plugins_resemble.egg-info/requires.txt

@@ -0,0 +1 @@
+livekit-agents[codecs]>=0.12.20

livekit_plugins_resemble-0.1.2/livekit_plugins_resemble.egg-info/top_level.txt

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

livekit_plugins_resemble-0.1.2/pyproject.toml

@@ -0,0 +1,3 @@
+[build-system]
+requires = ["setuptools>=61.0"]
+build-backend = "setuptools.build_meta" 

livekit_plugins_resemble-0.1.2/setup.cfg

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

livekit_plugins_resemble-0.1.2/setup.py

@@ -0,0 +1,55 @@
+# Copyright 2023 LiveKit, Inc.
+#
+# 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
+import setuptools.command.build_py
+
+here = pathlib.Path(__file__).parent.resolve()
+about = {}
+with open(os.path.join(here, "livekit", "plugins", "resemble", "version.py"), "r") as f:
+    exec(f.read(), about)
+
+
+setuptools.setup(
+    name="livekit-plugins-resemble",
+    version=about["__version__"],
+    description="LiveKit Agents Plugin for Resemble AI",
+    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",
+        "Topic :: Multimedia :: Sound/Audio",
+        "Topic :: Scientific/Engineering :: Artificial Intelligence",
+        "Programming Language :: Python :: 3",
+        "Programming Language :: Python :: 3.11",
+        "Programming Language :: Python :: 3.12",
+        "Programming Language :: Python :: 3 :: Only",
+    ],
+    keywords=["webrtc", "realtime", "audio", "video", "livekit", "resemble", "tts"],
+    license="Apache-2.0",
+    packages=setuptools.find_namespace_packages(include=["livekit.*"]),
+    python_requires=">=3.9.0",
+    install_requires=["livekit-agents[codecs]>=0.12.20"],
+    package_data={"livekit.plugins.resemble": ["py.typed"]},
+    project_urls={
+        "Documentation": "https://docs.livekit.io",
+        "Website": "https://livekit.io/",
+        "Source": "https://github.com/livekit/agents",
+    },
+)

livekit_plugins_resemble-0.1.0rc1/.gitignore

@@ -1,168 +0,0 @@
-**/.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_resemble-0.1.0rc1/pyproject.toml

@@ -1,41 +0,0 @@
-[build-system]
-requires = ["hatchling"]
-build-backend = "hatchling.build"
-
-[project]
-name = "livekit-plugins-resemble"
-dynamic = ["version"]
-description = "LiveKit Agents Plugin for Resemble AI"
-readme = "README.md"
-license = "Apache-2.0"
-requires-python = ">=3.9.0"
-authors = [{ name = "LiveKit", email = "hello@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.rc7",
-]
-
-[project.urls]
-Documentation = "https://docs.livekit.io"
-Website = "https://livekit.io/"
-Source = "https://github.com/livekit/agents"
-
-[tool.hatch.version]
-path = "livekit/plugins/resemble/version.py"
-
-[tool.hatch.build.targets.wheel]
-packages = ["livekit"]
-
-[tool.hatch.build.targets.sdist]
-include = ["/livekit"]