yapwrap 0.0.1a1__tar.gz

yapwrap-0.0.1a1/.github/workflows/publish.yml

@@ -0,0 +1,78 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  build:
+    name: Test and build distributions
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v7
+        with:
+          persist-credentials: false
+
+      - uses: actions/setup-python@v7
+        with:
+          python-version: "3.12"
+
+      - name: Install test and build dependencies
+        run: python -m pip install ".[dev,web]" build twine
+
+      - name: Check the release tag matches the package version
+        env:
+          RELEASE_TAG: ${{ github.event.release.tag_name }}
+        run: |
+          python - <<'PY'
+          import os
+          from pathlib import Path
+          import tomllib
+
+          import yapwrap
+
+          project = tomllib.loads(Path("pyproject.toml").read_text(encoding="utf-8"))["project"]
+          version = project["version"]
+          tag = os.environ["RELEASE_TAG"]
+          if tag != f"v{version}":
+              raise SystemExit(f"Release tag {tag!r} must be v{version} to match pyproject.toml")
+          if yapwrap.__version__ != version:
+              raise SystemExit("Update yapwrap.__version__ to match pyproject.toml")
+          PY
+
+      - name: Run tests
+        run: python -m pytest -q -p no:cacheprovider
+
+      - name: Build and validate distributions
+        run: |
+          python -m build
+          python -m twine check --strict dist/*
+
+      - uses: actions/upload-artifact@v7
+        with:
+          name: python-distributions
+          path: dist/
+          if-no-files-found: error
+
+  publish:
+    name: Upload to PyPI
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/yapwrap
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v8
+        with:
+          name: python-distributions
+          path: dist/
+
+      # Register the PyPI project yapwrap with this GitHub repository,
+      # workflow publish.yml, and environment pypi as its Trusted Publisher.
+      - name: Publish with Trusted Publishing
+        uses: pypa/gh-action-pypi-publish@release/v1

yapwrap-0.0.1a1/.gitignore

@@ -0,0 +1,14 @@
+# Python-generated files
+__pycache__/
+*.py[oc]
+build/
+dist/
+wheels/
+*.egg-info
+
+# Virtual environments
+.venv
+.pytest_cache/
+.ruff_cache/
+.uv-cache/
+.env

yapwrap-0.0.1a1/.python-version

@@ -0,0 +1 @@
+3.14

yapwrap-0.0.1a1/LICENSE

@@ -0,0 +1,201 @@
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   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.

yapwrap-0.0.1a1/PKG-INFO

@@ -0,0 +1,339 @@
+Metadata-Version: 2.5
+Name: yapwrap
+Version: 0.0.1a1
+Summary: Framework-agnostic streaming voice pipeline for AI agents
+Author: YapWrap Contributors
+License-Expression: Apache-2.0
+License-File: LICENSE
+Keywords: agent,llm,realtime,streaming,stt,tts,vad,voice
+Requires-Python: >=3.10
+Requires-Dist: httpx>=0.27.0
+Requires-Dist: typing-extensions>=4.8.0
+Provides-Extra: all
+Requires-Dist: aiortc>=1.9.0; extra == 'all'
+Requires-Dist: fastapi>=0.115.0; extra == 'all'
+Requires-Dist: httpx>=0.27.0; extra == 'all'
+Requires-Dist: numpy>=1.24.0; extra == 'all'
+Requires-Dist: onnxruntime>=1.16.0; extra == 'all'
+Requires-Dist: openai>=1.50.0; extra == 'all'
+Requires-Dist: silero-vad>=6.0.0; extra == 'all'
+Requires-Dist: sounddevice>=0.5.0; extra == 'all'
+Requires-Dist: uvicorn>=0.30.0; extra == 'all'
+Requires-Dist: websockets>=13.0; extra == 'all'
+Provides-Extra: audio
+Requires-Dist: numpy>=1.24.0; extra == 'audio'
+Provides-Extra: cartesia
+Requires-Dist: websockets>=13.0; extra == 'cartesia'
+Provides-Extra: deepgram
+Requires-Dist: websockets>=13.0; extra == 'deepgram'
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.23.0; extra == 'dev'
+Requires-Dist: pytest>=8.0.0; extra == 'dev'
+Provides-Extra: elevenlabs
+Requires-Dist: httpx>=0.27.0; extra == 'elevenlabs'
+Requires-Dist: websockets>=13.0; extra == 'elevenlabs'
+Provides-Extra: local
+Requires-Dist: sounddevice>=0.5.0; extra == 'local'
+Provides-Extra: openai
+Requires-Dist: openai>=1.50.0; extra == 'openai'
+Provides-Extra: silero
+Requires-Dist: numpy>=1.24.0; extra == 'silero'
+Requires-Dist: onnxruntime>=1.16.0; extra == 'silero'
+Requires-Dist: silero-vad>=6.0.0; extra == 'silero'
+Provides-Extra: web
+Requires-Dist: fastapi>=0.115.0; extra == 'web'
+Requires-Dist: uvicorn>=0.30.0; extra == 'web'
+Requires-Dist: websockets>=13.0; extra == 'web'
+Provides-Extra: webrtc
+Requires-Dist: aiortc>=1.9.0; extra == 'webrtc'
+Provides-Extra: webrtc-vad
+Requires-Dist: webrtcvad>=2.0.10; extra == 'webrtc-vad'
+Provides-Extra: websockets
+Requires-Dist: websockets>=13.0; extra == 'websockets'
+Description-Content-Type: text/markdown
+
+# Introducing YapWrap
+
+**Make your agents yap.**
+
+Give the agent you've already built a voice. YapWrap connects your existing
+Python agent to speech recognition, speech synthesis, and live audio—so people
+can talk to it.
+
+You've chosen a framework, configured a model, connected tools, and worked out
+memory and workflows. YapWrap starts with that agent. Wrap it in an adapter,
+choose your speech providers, and turn it into a yapper.
+
+Built-in adapters cover **Agno, Claude Agent SDK, CrewAI, Google ADK,
+Hugging Face smolagents, LangGraph / LangChain agents, LlamaIndex,
+Microsoft Agent Framework, OpenAI Agents SDK, and Pydantic AI**.
+Custom Python agents can connect through `CallableAgent` or a `BaseAgent` subclass.
+See [every adapter and its example](#bring-your-framework).
+
+Start with any framework—or your own agent implementation. Here, `reply` is
+your application's function that accepts user text and returns reply text or
+a stream of text chunks:
+
+```python
+import asyncio
+
+from yapwrap import YapWrap
+from yapwrap.agents import CallableAgent
+from yapwrap.stt import DeepgramSTT
+from yapwrap.tts import CartesiaTTS
+from yapwrap.vad import SileroVAD
+
+from your_app import reply  # Your existing agent's text-in, text-out entry point.
+
+yapper = YapWrap(
+    agent=CallableAgent(reply),
+    stt=DeepgramSTT(),
+    tts=CartesiaTTS(),
+    vad=SileroVAD(),
+)
+
+asyncio.run(yapper.startlocal())
+```
+
+Your function keeps calling your agent with its configured model, instructions,
+tools, and session state. It can be synchronous or asynchronous. YapWrap handles
+listening and speaking.
+
+You can also wrap framework objects directly with a [built-in adapter](#bring-your-framework).
+Install the voice dependencies below and keep your agent's own credentials and
+session configuration.
+
+**[Try it locally](#get-talking) · [Try it in your browser](#choose-where-your-agent-yaps) · [Find your framework](#bring-your-framework) · [Build an adapter](#make-it-your-own)**
+
+## Why YapWrap?
+
+Adding voice to an existing agent brings a new set of concerns: microphone
+input, speech recognition, turn detection, audio playback, interruptions, and
+keeping the conversation visible. Reusing an agent also means connecting its
+input, output, and session state to that voice pipeline.
+
+YapWrap puts that connection at the center of its API:
+
+- **Bring your agent.** Use an adapter around your configured agent, graph,
+  runner, or client. Your framework continues to execute its tools and workflows.
+- **Choose your speech stack.** Configure STT, TTS, and voice activity detection
+  independently of the agent.
+- **Handle conversation turns.** Detect speech, turn reply text into spoken
+  phrases, and clear queued playback when the user interrupts.
+- **Talk locally or in a browser.** Use microphone and speakers, WebSockets,
+  FastAPI, or WebRTC. The included clients show both sides of the conversation.
+- **Extend through base classes.** Add an agent, provider, or transport by
+  implementing a small, explicit interface.
+
+The core imports no agent framework, web framework, audio device, or model SDK.
+Integrations are optional.
+
+```text
+Your voice → speech recognition → your existing agent → speech synthesis → its voice
+```
+
+## Get talking
+
+Python 3.10+ is required by YapWrap; individual framework SDKs can require a newer
+version. From the repository root, install the example dependencies:
+
+```sh
+uv sync --group examples --extra local --extra web --extra silero --extra deepgram --extra cartesia
+```
+
+Set your provider keys. The demos use Agno with Gemini, Deepgram for recognition,
+Cartesia for speech, and Silero for voice activity detection.
+
+```sh
+export GOOGLE_API_KEY="your-google-key"
+export DEEPGRAM_API_KEY="your-deepgram-key"
+export CARTESIA_API_KEY="your-cartesia-key"
+```
+
+<details>
+<summary>PowerShell</summary>
+
+```powershell
+$env:GOOGLE_API_KEY = "your-google-key"
+$env:DEEPGRAM_API_KEY = "your-deepgram-key"
+$env:CARTESIA_API_KEY = "your-cartesia-key"
+```
+
+</details>
+
+Start a local conversation:
+
+```sh
+uv run python -m examples.transports.local
+```
+
+Wait for `Session online`, then speak. The terminal prints your recognized
+words and streams the agent's reply. Press Ctrl+C to stop.
+
+`GEMINI_API_KEY` is also accepted. Set `GEMINI_MODEL` to change the example model;
+the default is `gemini-flash-lite-latest`. These are example defaults—you choose
+the model and providers in your own application.
+
+For an application using this checkout, install only the integrations you need:
+
+```sh
+python -m pip install -e ".[local,silero,deepgram,cartesia]"
+```
+
+Install your agent's framework and model SDK separately. This command installs
+YapWrap's voice dependencies; the `examples` group above also installs Agno and
+Google's model SDK. See the [example guide](examples/README.md) for other setups.
+
+## Choose where your agent yaps
+
+| Experience | Example | Run from the repository root |
+| --- | --- | --- |
+| Microphone, speakers, and terminal transcript | [Local audio](examples/transports/local.py) | `uv run python -m examples.transports.local` |
+| Browser voice chat and transcript | [FastAPI WebSocket](examples/transports/fastapi_websocket.py) | `uv run python -m examples.transports.fastapi_websocket` |
+| A socket for your own client | [Standalone WebSocket](examples/transports/websocket.py) | `uv run python -m examples.transports.websocket` |
+| Browser audio over WebRTC | [WebRTC](examples/transports/webrtc.py) | `uv run --extra webrtc python -m examples.transports.webrtc` |
+
+For either browser server, open <http://localhost:8000>, allow microphone access,
+and start a call. Run one at a time; both use port 8000. The standalone socket
+listens on port 8765; its [browser client instructions](examples/README.md#transport-examples)
+show how to serve the HTML separately.
+
+Every example contains an explicit `yapper = YapWrap(...)`. Server examples
+construct it inside the connection handler, giving each call its own agent,
+speech components, and conversation state.
+
+In your application, choose the matching entry point:
+
+- `await yapper.startlocal()` for microphone and speakers.
+- `await yapper.server_ws(ws=websocket)` for an accepted WebSocket connection.
+- `await yapper.run(transport)` for a `BaseTransport` implementation.
+
+A single `YapWrap` instance serves one conversation at a time.
+
+## Bring your framework
+
+Built-in adapters connect these Python agent APIs. Each linked example shows
+the required SDK dependencies, object types, and session setup.
+
+| Your agent | YapWrap adapter | Example |
+| --- | --- | --- |
+| Agno | `AgnoAgent` | [Agno](examples/frameworks/agno_agent.py) |
+| LangGraph / LangChain agents | `LangGraphAgent` | [LangGraph](examples/frameworks/langgraph_agent.py) |
+| Pydantic AI | `PydanticAIAgent` | [Pydantic AI](examples/frameworks/pydantic_ai_agent.py) |
+| OpenAI Agents SDK | `OpenAIAgentsSDKAgent` | [OpenAI Agents](examples/frameworks/openai_agents_sdk.py) |
+| Google ADK | `GoogleADKAgent` | [Google ADK](examples/frameworks/google_adk_agent.py) |
+| Claude Agent SDK | `ClaudeAgentSDKAgent` | [Claude Agent SDK](examples/frameworks/claude_agent_sdk.py) |
+| CrewAI | `CrewAIAgent` | [CrewAI](examples/frameworks/crewai_agent.py) |
+| LlamaIndex | `LlamaIndexAgent` | [LlamaIndex](examples/frameworks/llamaindex_agent.py) |
+| Microsoft Agent Framework | `MicrosoftAgentFrameworkAgent` | [Microsoft Agent Framework](examples/frameworks/microsoft_agent.py) |
+| Hugging Face smolagents | `SmolAgentsAgent` | [smolagents](examples/frameworks/smolagents_agent.py) |
+| Your own Python function or stream | `CallableAgent` | [Callable](examples/frameworks/callable_agent.py) |
+
+Adapters translate recognized text into framework calls and reply text into
+YapWrap events. They work with the interfaces shown in the examples; arbitrary
+graph inputs, structured outputs, or application-specific events may need a
+custom adapter. CrewAI and smolagents currently speak the final answer.
+
+### Keep your framework's memory
+
+Continue using your framework's session, history, and persistence mechanisms.
+Pass the relevant run options through its adapter—for example, an Agno
+`session_id`, a LangGraph `config` with a `thread_id`, or a LlamaIndex `ctx`.
+
+YapWrap does not automatically migrate or populate agent memory. Its
+`yapper.memory` records generated conversation turns and interruptions.
+Your application decides which framework session each voice conversation uses.
+
+## Where YapWrap fits
+
+Pipecat and LiveKit can also connect existing agent logic.
+[Pipecat includes a LangChain processor](https://github.com/pipecat-ai/pipecat/blob/main/src/pipecat/processors/frameworks/langchain.py),
+and [LiveKit provides a LangGraph/LangChain adapter](https://docs.livekit.io/agents/models/llm/langchain/).
+
+YapWrap focuses on a direct Python integration: take an existing agent, wrap its
+text interface, choose speech components, and run it through a transport.
+It's built for developers who want to add voice while continuing to own their
+agent's framework, tools, and session setup.
+
+## Make it your own
+
+Have an agent with a custom API? Use `CallableAgent` for a function that accepts
+text and returns text or a stream of text. For more control, subclass `BaseAgent`:
+
+```python
+from collections.abc import AsyncIterator
+
+from yapwrap import AgentEvent, BaseAgent
+
+class MyAgent(BaseAgent):
+    def __init__(self, existing_agent):
+        self.existing_agent = existing_agent
+
+    async def respond(self, text: str) -> AsyncIterator[AgentEvent]:
+        # Adapt this call to your application's text-response API.
+        reply = await self.existing_agent.reply(text)
+        yield AgentEvent.text(reply)
+```
+
+Pass `MyAgent(existing_agent)` as the `agent` argument to `YapWrap`.
+Stream `AgentEvent.text(delta)` as text arrives when your agent supports it.
+
+The same approach applies to the rest of the pipeline:
+
+| Base class | Implement |
+| --- | --- |
+| `BaseAgent` | `respond(text)` → async stream of agent events |
+| `BaseSTT` | `transcribe(audio)` → async stream of transcripts |
+| `BaseTTS` | `synthesize(text)` → async stream of PCM audio |
+| `BaseVAD` | `process(pcm)` → `"start"`, `"stop"`, or `None` |
+| `BaseTransport` | `audio_in()`, `send_audio(pcm)`, and `stop_playback()` |
+
+All five classes are exported from `yapwrap`. Start with the
+[interface contracts](src/yapwrap/core/base.py) or run the
+[custom components walkthrough](examples/custom_components.py) without keys or hardware:
+
+```sh
+uv run python -m examples.custom_components
+```
+
+Choose dependencies per integration: `local`, `web`, `websockets`, `webrtc`,
+`silero`, `webrtc-vad`, `deepgram`, `cartesia`, `openai`, and `elevenlabs`
+are available as extras; `audio` adds NumPy acceleration. The `all` extra
+covers the listed runtime extras except `webrtc-vad`. Framework SDKs and
+additional provider SDKs are installed separately.
+
+## Working with real conversations
+
+- **Audio:** components exchange raw PCM16 mono at a matching sample rate,
+  defaulting to 16 kHz. Custom transports convert their audio at the boundary.
+- **Transcripts:** local and browser clients display user and agent text.
+  Custom transports can implement `send_event()` to receive `transcript`,
+  `agent_delta`, and `agent_complete` events. The transcript records generated
+  text; it does not confirm which audio the listener heard.
+- **Interruptions:** a speech start cancels the current reply and clears queued
+  playback. Synchronous work running in a Python thread cannot be forcibly
+  stopped. Cancellation does not undo tool actions already performed.
+- **Deployment:** the browser examples target localhost. Your application owns
+  authentication, HTTPS, and any STUN/TURN configuration needed for WebRTC.
+- **Validation:** automated checks cover the core, adapter behavior, provider
+  protocol messages with mock connections, browser playback, and a local WebRTC
+  exchange. Live provider compatibility and microphone/speaker quality still
+  need testing with your configuration. Response time depends on the agent,
+  speech providers, and network.
+
+## Development
+
+After installing the example dependencies:
+
+```sh
+uv run pytest -q -p no:cacheprovider
+node tests/browser_client.test.cjs
+uv build
+```
+
+Optional integration tests skip when their dependencies are absent. The build
+produces a wheel and source archive that include the license.
+
+## License
+
+[Apache License, Version 2.0](LICENSE).