musubi-livekit 0.1.0__tar.gz

musubi_livekit-0.1.0/.github/workflows/ci.yml

@@ -0,0 +1,45 @@
+name: CI
+
+on:
+  push:
+    branches: [main]
+  pull_request:
+    branches: [main]
+
+permissions:
+  contents: read
+
+jobs:
+  verify:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4
+      - uses: astral-sh/setup-uv@v8.1.0
+      - run: uv sync --locked --python 3.12
+      - run: uv run ruff check src tests
+      - run: uv run ruff format --check src tests
+      - run: uv run mypy src/musubi_livekit
+      - run: uv run pytest -q
+      - run: uv build
+
+  integration:
+    runs-on: ubuntu-latest
+    timeout-minutes: 35
+    steps:
+      - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4
+      - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4
+        with:
+          repository: sourceblender/musubi
+          ref: v1.27.1
+          path: core
+      - uses: astral-sh/setup-uv@v8.1.0
+      - run: uv sync --extra dev --python 3.12
+        working-directory: core
+      - run: uv pip install --python core/.venv/bin/python musubi-sdk==0.1.0
+      - run: uv pip install --python core/.venv/bin/python --no-deps -e .
+      - run: cp tests/integration/test_livekit_e2e.py core/tests/integration/test_livekit_plugin_e2e.py
+      - run: uv run --no-sync --extra dev pytest -q -m integration tests/integration/test_livekit_plugin_e2e.py
+        working-directory: core
+        env:
+          # Core's chunked sparse embedder loads the gated SPLADE-v3 tokenizer.
+          HF_TOKEN: ${{ secrets.HF_TOKEN }}

musubi_livekit-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,56 @@
+name: Publish musubi-livekit
+
+on:
+  push:
+    tags: ["v[0-9]+.[0-9]+.[0-9]+"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    permissions:
+      contents: read
+    steps:
+      - uses: actions/checkout@11d5960a326750d5838078e36cf38b85af677262 # v4
+        with:
+          persist-credentials: false
+      - uses: astral-sh/setup-uv@v8.1.0
+        with:
+          enable-cache: false
+      - name: Check tag matches package version
+        run: |
+          python3 - <<'PY'
+          import os
+          import tomllib
+
+          with open("pyproject.toml", "rb") as source:
+              version = tomllib.load(source)["project"]["version"]
+          assert os.environ["GITHUB_REF_NAME"] == f"v{version}", "tag and package version differ"
+          PY
+      - run: uv build
+      - name: Smoke test wheel and source distribution
+        run: |
+          for artifact in dist/*.whl dist/*.tar.gz; do
+            uv venv /tmp/musubi-livekit-publish-check --python 3.12 --clear
+            uv pip install --python /tmp/musubi-livekit-publish-check/bin/python "$artifact"
+            /tmp/musubi-livekit-publish-check/bin/python -c 'import importlib.util as u; import musubi_livekit, musubi_livekit.adapter, musubi_livekit.cache, musubi_livekit.config, musubi_livekit.fast_talker, musubi_livekit.heuristics, musubi_livekit.redaction, musubi_livekit.slow_thinker, musubi_sdk; assert u.find_spec("musubi") is None'
+          done
+      - uses: actions/upload-artifact@043fb46d1a93c77aae656e7c1c64a875d1fc6a0a # v7.0.1
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write
+    steps:
+      - uses: astral-sh/setup-uv@v8.1.0
+        with:
+          enable-cache: false
+      - uses: actions/download-artifact@3e5f45b2cfb9172054b4087a40e8e0b5a5461e7c # v8.0.1
+        with:
+          name: dist
+          path: dist/
+      - run: uv publish

musubi_livekit-0.1.0/.gitignore

@@ -0,0 +1,7 @@
+.venv/
+__pycache__/
+.pytest_cache/
+.ruff_cache/
+.mypy_cache/
+*.egg-info/
+dist/

musubi_livekit-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 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.

musubi_livekit-0.1.0/PKG-INFO

@@ -0,0 +1,108 @@
+Metadata-Version: 2.5
+Name: musubi-livekit
+Version: 0.1.0
+Summary: LiveKit session callback adapter for the Musubi memory SDK
+Project-URL: Homepage, https://github.com/sourceblender/musubi-livekit
+Project-URL: Repository, https://github.com/sourceblender/musubi-livekit
+Project-URL: Issues, https://github.com/sourceblender/musubi-livekit/issues
+License-Expression: Apache-2.0
+License-File: LICENSE
+Requires-Python: >=3.12
+Requires-Dist: musubi-sdk>=0.1.0
+Description-Content-Type: text/markdown
+
+# musubi-livekit
+
+`musubi-livekit` connects a LiveKit voice session's callbacks to the Musubi
+memory API. It provides a `LiveKitAdapter`, a slow prefetcher, a fast context
+reader, a bounded cache, optional fact capture, and transcript handling. The
+package is a Python library: your LiveKit worker still owns the session,
+event subscriptions, credentials, and user-facing responses.
+
+## Install
+
+Requires Python 3.12 or later. The adapter depends on the standalone
+[`musubi-sdk`](https://pypi.org/project/musubi-sdk/) client, not the Musubi server.
+The SDK is installed from PyPI as a dependency:
+
+```bash
+pip install 'git+https://github.com/sourceblender/musubi-livekit.git'
+```
+
+The plugin itself is not published to PyPI yet; the GitHub install above is
+the current supported install path.
+
+## Use in a worker
+
+Construct one adapter per voice session. Feed it the transcript and session
+events from your own LiveKit worker. These are callbacks to wire into the
+worker, not an automatically installed LiveKit plugin.
+
+```python
+from musubi_sdk import AsyncMusubiClient
+from musubi_livekit import LiveKitAdapter, LiveKitAdapterConfig
+
+client = AsyncMusubiClient(base_url=api_url, token=token)
+adapter = LiveKitAdapter(
+    client=client,
+    namespace="assistant/voice/episodic",
+    artifact_namespace="assistant/voice/artifact",
+    config=LiveKitAdapterConfig(
+        capture_transcripts=False,
+        capture_facts=False,
+    ),
+)
+
+# Call from the matching LiveKit worker events:
+await adapter.on_transcript_segment(partial_text)
+await adapter.on_user_turn_completed(final_text)
+context = await adapter.fast_talker.get_context(final_text)
+warnings = adapter.retrieval_status
+await adapter.on_session_end(session_id=session_id, vtt_transcript=vtt_text)
+```
+
+Fact and transcript capture are enabled in the default config. Set the privacy
+flags deliberately for your application before handling a real session.
+`retrieval_status` exposes degradation warnings so the worker can tell the
+user when memory is unavailable. A successful callback call is not a guarantee
+that a transcript reached artifact storage: until the SDK has `artifacts.upload`,
+the adapter falls back to episodic capture. See the code and tests before
+promising artifact storage or delivery guarantees.
+
+## Development
+
+```bash
+uv sync --locked --python 3.12
+uv run pytest -q
+uv run ruff check src tests
+uv run ruff format --check src tests
+uv run mypy src/musubi_livekit
+```
+
+The unit suite exercises the extracted adapter and retrieval degradation
+channel. Three historical tests remain skipped because they require a running
+Musubi stack and a LiveKit session simulator; they are not release evidence.
+
+Five integration tests exercise the adapter through the real Musubi SDK and API.
+They write memories and thoughts, so point them only at a disposable test stack
+with an operator-scoped test token:
+
+```bash
+MUSUBI_TEST_API_URL=http://127.0.0.1:8100/v1 \
+MUSUBI_TEST_TOKEN=<disposable-test-token> \
+uv run pytest -q -m integration tests/integration/test_livekit_e2e.py
+```
+
+The default test command excludes these integration tests. Their fixture
+skips when either variable is missing. Linux CI also runs them against
+Musubi's disposable Docker integration stack; the pinned TEI test image has
+no ARM64 manifest, so that stack does not boot natively on Apple Silicon.
+
+## Contributing and security
+
+Discuss substantial changes in an issue first. Follow the
+[Sourceblender contributing guide](https://github.com/sourceblender/.github/blob/main/CONTRIBUTING.md).
+Report security issues privately through the repository Security tab or the
+[organization policy](https://github.com/sourceblender/.github/blob/main/SECURITY.md).
+
+Licensed under Apache-2.0. See [LICENSE](LICENSE).

musubi_livekit-0.1.0/README.md

@@ -0,0 +1,95 @@
+# musubi-livekit
+
+`musubi-livekit` connects a LiveKit voice session's callbacks to the Musubi
+memory API. It provides a `LiveKitAdapter`, a slow prefetcher, a fast context
+reader, a bounded cache, optional fact capture, and transcript handling. The
+package is a Python library: your LiveKit worker still owns the session,
+event subscriptions, credentials, and user-facing responses.
+
+## Install
+
+Requires Python 3.12 or later. The adapter depends on the standalone
+[`musubi-sdk`](https://pypi.org/project/musubi-sdk/) client, not the Musubi server.
+The SDK is installed from PyPI as a dependency:
+
+```bash
+pip install 'git+https://github.com/sourceblender/musubi-livekit.git'
+```
+
+The plugin itself is not published to PyPI yet; the GitHub install above is
+the current supported install path.
+
+## Use in a worker
+
+Construct one adapter per voice session. Feed it the transcript and session
+events from your own LiveKit worker. These are callbacks to wire into the
+worker, not an automatically installed LiveKit plugin.
+
+```python
+from musubi_sdk import AsyncMusubiClient
+from musubi_livekit import LiveKitAdapter, LiveKitAdapterConfig
+
+client = AsyncMusubiClient(base_url=api_url, token=token)
+adapter = LiveKitAdapter(
+    client=client,
+    namespace="assistant/voice/episodic",
+    artifact_namespace="assistant/voice/artifact",
+    config=LiveKitAdapterConfig(
+        capture_transcripts=False,
+        capture_facts=False,
+    ),
+)
+
+# Call from the matching LiveKit worker events:
+await adapter.on_transcript_segment(partial_text)
+await adapter.on_user_turn_completed(final_text)
+context = await adapter.fast_talker.get_context(final_text)
+warnings = adapter.retrieval_status
+await adapter.on_session_end(session_id=session_id, vtt_transcript=vtt_text)
+```
+
+Fact and transcript capture are enabled in the default config. Set the privacy
+flags deliberately for your application before handling a real session.
+`retrieval_status` exposes degradation warnings so the worker can tell the
+user when memory is unavailable. A successful callback call is not a guarantee
+that a transcript reached artifact storage: until the SDK has `artifacts.upload`,
+the adapter falls back to episodic capture. See the code and tests before
+promising artifact storage or delivery guarantees.
+
+## Development
+
+```bash
+uv sync --locked --python 3.12
+uv run pytest -q
+uv run ruff check src tests
+uv run ruff format --check src tests
+uv run mypy src/musubi_livekit
+```
+
+The unit suite exercises the extracted adapter and retrieval degradation
+channel. Three historical tests remain skipped because they require a running
+Musubi stack and a LiveKit session simulator; they are not release evidence.
+
+Five integration tests exercise the adapter through the real Musubi SDK and API.
+They write memories and thoughts, so point them only at a disposable test stack
+with an operator-scoped test token:
+
+```bash
+MUSUBI_TEST_API_URL=http://127.0.0.1:8100/v1 \
+MUSUBI_TEST_TOKEN=<disposable-test-token> \
+uv run pytest -q -m integration tests/integration/test_livekit_e2e.py
+```
+
+The default test command excludes these integration tests. Their fixture
+skips when either variable is missing. Linux CI also runs them against
+Musubi's disposable Docker integration stack; the pinned TEI test image has
+no ARM64 manifest, so that stack does not boot natively on Apple Silicon.
+
+## Contributing and security
+
+Discuss substantial changes in an issue first. Follow the
+[Sourceblender contributing guide](https://github.com/sourceblender/.github/blob/main/CONTRIBUTING.md).
+Report security issues privately through the repository Security tab or the
+[organization policy](https://github.com/sourceblender/.github/blob/main/SECURITY.md).
+
+Licensed under Apache-2.0. See [LICENSE](LICENSE).

musubi_livekit-0.1.0/pyproject.toml

@@ -0,0 +1,57 @@
+[project]
+name = "musubi-livekit"
+version = "0.1.0"
+description = "LiveKit session callback adapter for the Musubi memory SDK"
+readme = "README.md"
+requires-python = ">=3.12"
+license = "Apache-2.0"
+dependencies = [
+  "musubi-sdk>=0.1.0",
+]
+
+[project.urls]
+Homepage = "https://github.com/sourceblender/musubi-livekit"
+Repository = "https://github.com/sourceblender/musubi-livekit"
+Issues = "https://github.com/sourceblender/musubi-livekit/issues"
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/musubi_livekit"]
+
+[dependency-groups]
+dev = ["pytest>=8", "pytest-asyncio>=0.23", "ruff>=0.6", "mypy>=1.11"]
+
+[tool.pytest.ini_options]
+asyncio_mode = "auto"
+testpaths = ["tests"]
+addopts = "-m 'not integration'"
+markers = ["integration: writes to a disposable Musubi API stack; opt in explicitly"]
+
+[tool.ruff]
+line-length = 100
+target-version = "py312"
+
+[tool.ruff.lint]
+select = ["E", "F", "W", "I", "B", "UP", "C4", "SIM", "RUF"]
+ignore = ["E501"]
+
+[tool.ruff.lint.per-file-ignores]
+"tests/*" = ["B"]
+
+[tool.mypy]
+python_version = "3.12"
+strict = true
+pretty = true
+show_error_codes = true
+files = ["src/musubi_livekit"]
+
+[[tool.mypy.overrides]]
+module = ["musubi_sdk.*"]
+ignore_missing_imports = true
+
+[[tool.mypy.overrides]]
+module = ["musubi.sdk.exceptions"]
+ignore_missing_imports = true

musubi_livekit-0.1.0/src/musubi_livekit/__init__.py

@@ -0,0 +1,23 @@
+"""LiveKit session callback adapter backed by the Musubi Python SDK.
+
+This package is a library for a LiveKit worker to call from its event
+handlers. It does not install or start a LiveKit worker by itself.
+"""
+
+from musubi_livekit.adapter import LiveKitAdapter
+from musubi_livekit.cache import ContextCache
+from musubi_livekit.config import LiveKitAdapterConfig
+from musubi_livekit.fast_talker import FastTalker
+from musubi_livekit.heuristics import detect_interesting_fact
+from musubi_livekit.redaction import redact_pii
+from musubi_livekit.slow_thinker import SlowThinker
+
+__all__ = [
+    "ContextCache",
+    "FastTalker",
+    "LiveKitAdapter",
+    "LiveKitAdapterConfig",
+    "SlowThinker",
+    "detect_interesting_fact",
+    "redact_pii",
+]