livekit-plugins-hamming 1.5.1__tar.gz

livekit_plugins_hamming-1.5.1/.gitignore

@@ -0,0 +1,179 @@
+**/.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
+
+# trunk
+.trunk/
+
+# 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
+docs/
+
+# Database files
+*.db
+
+
+# Examples for development
+examples/dev/*

livekit_plugins_hamming-1.5.1/PKG-INFO

@@ -0,0 +1,179 @@
+Metadata-Version: 2.4
+Name: livekit-plugins-hamming
+Version: 1.5.1
+Summary: Monitoring plugin for exporting LiveKit AgentSession call review payloads to Hamming
+Project-URL: Documentation, https://docs.hamming.ai
+Project-URL: Website, https://hamming.ai/
+Project-URL: Source, https://github.com/livekit/agents
+Author-email: Hamming <engineering@hamming.ai>
+License-Expression: Apache-2.0
+Keywords: ai,audio,hamming,livekit,monitoring,realtime,video,voice
+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.10
+Classifier: Topic :: Multimedia :: Sound/Audio
+Classifier: Topic :: Multimedia :: Video
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10.0
+Requires-Dist: aiohttp>=3.9
+Requires-Dist: livekit-agents>=1.5.1
+Description-Content-Type: text/markdown
+
+# Hamming plugin for LiveKit Agents
+
+Post-call monitoring for LiveKit Agents with Hamming.
+
+## Installation
+
+Install the plugin from a checked out repository or extracted source archive:
+
+```bash
+python -m pip install ./livekit-plugins/livekit-plugins-hamming
+```
+
+## Pre-requisites
+
+You will need Hamming credentials before configuring the plugin.
+
+- `HAMMING_API_KEY`
+- `HAMMING_EXTERNAL_AGENT_ID`
+
+Credentials can be passed directly or through environment variables.
+
+## Usage
+
+```python
+import os
+
+from livekit.agents import AgentSession, JobContext
+from livekit.plugins import hamming
+
+
+async def entrypoint(ctx: JobContext) -> None:
+    await ctx.connect()
+
+    hamming.configure_hamming(
+        api_key=os.environ["HAMMING_API_KEY"],
+        external_agent_id=os.environ["HAMMING_EXTERNAL_AGENT_ID"],
+        recording={"mode": "session_audio"},
+    )
+
+    session = AgentSession()
+    hamming.attach_session(session, job_ctx=ctx)
+```
+
+## Recording Modes
+
+The plugin supports explicit recording modes through `configure_hamming(recording=...)`.
+If `recording` is omitted, the plugin exports monitoring payloads only and does not start or resolve recordings.
+
+- `none`
+  - Send monitoring payload only.
+- `session_audio`
+  - Use LiveKit session recording and inline `recording_capture` on the final `/collect` payload.
+- `participant_egress`
+  - Start managed LiveKit participant egress and send dual-track recording URLs derived from deterministic output paths.
+- `room_composite`
+  - Start managed LiveKit room composite egress and send a single `recording_url` derived from a deterministic output path.
+
+### Session Audio (Default Simple Path)
+
+```python
+hamming.configure_hamming(
+    api_key=os.environ["HAMMING_API_KEY"],
+    external_agent_id=os.environ["HAMMING_EXTERNAL_AGENT_ID"],
+    recording={"mode": "session_audio"},
+)
+```
+
+### Managed Participant Egress
+
+```python
+hamming.configure_hamming(
+    api_key=os.environ["HAMMING_API_KEY"],
+    external_agent_id=os.environ["HAMMING_EXTERNAL_AGENT_ID"],
+    recording={
+        "mode": "participant_egress",
+        "livekit": {
+            "url": os.environ["LIVEKIT_URL"],
+            "api_key": os.environ["LIVEKIT_API_KEY"],
+            "api_secret": os.environ["LIVEKIT_API_SECRET"],
+        },
+        "s3": {
+            # Required for deterministic artifact URL resolution.
+            "public_url_base": os.environ.get("LIVEKIT_RECORDING_PUBLIC_URL_BASE", ""),
+            # Optional. Include upload credentials only if the plugin should write
+            # directly to S3 instead of relying on LiveKit project defaults.
+            "access_key": os.environ.get("LIVEKIT_RECORDING_S3_ACCESS_KEY", ""),
+            "secret": os.environ.get("LIVEKIT_RECORDING_S3_SECRET", ""),
+            "region": os.environ.get("LIVEKIT_RECORDING_S3_REGION", ""),
+            "bucket": os.environ.get("LIVEKIT_RECORDING_S3_BUCKET", ""),
+        },
+    },
+)
+```
+
+### Managed Room Composite
+
+```python
+hamming.configure_hamming(
+    api_key=os.environ["HAMMING_API_KEY"],
+    external_agent_id=os.environ["HAMMING_EXTERNAL_AGENT_ID"],
+    recording={
+        "mode": "room_composite",
+        "livekit": {
+            "url": os.environ["LIVEKIT_URL"],
+            "api_key": os.environ["LIVEKIT_API_KEY"],
+            "api_secret": os.environ["LIVEKIT_API_SECRET"],
+        },
+        "audio_only": True,
+        "file_type": "ogg",
+    },
+)
+```
+
+Notes:
+
+- Managed remote recording modes require LiveKit server API credentials.
+- Managed remote recording modes also require `job_ctx` when calling `hamming.attach_session(...)`.
+- Managed remote recording modes require deterministic artifact URL resolution via `recording.s3.public_url_base` or `recording.s3.bucket` + `recording.s3.region`.
+- If you provide full S3 credentials, the plugin uses those upload settings for egress output.
+- If you omit S3 upload credentials, your LiveKit project must already have default file output storage configured.
+- The plugin does not poll LiveKit for completed artifact locations; it derives the final public URLs from the configured output path.
+
+## Verify configuration
+
+```python
+import os
+
+from livekit.plugins import hamming
+
+report = hamming.doctor(api_key=os.environ["HAMMING_API_KEY"])
+print(report.to_dict())
+```
+
+## Notes
+
+- Sessions are exported when attached through `hamming.attach_session(...)`.
+- Recording is opt-in. Omitting `recording=...` sends monitoring payloads without recording artifacts.
+- `auto_record_audio=True` is still supported as a backward-compatible alias for `recording={"mode": "session_audio"}`.
+- Managed remote recording modes stop egress on close and send deterministic artifact URLs through the same `/api/rest/v2/collect` ingestion path.
+
+## Troubleshooting
+
+- `RuntimeError: hamming is not configured`
+  - Call `hamming.configure_hamming(...)` before `hamming.attach_session(...)`.
+- `ValueError: Hamming API key required`
+  - Set `HAMMING_API_KEY` or pass `api_key=...`.
+- `external_agent_id is required`
+  - Set `HAMMING_EXTERNAL_AGENT_ID` or pass `external_agent_id=...`.
+- `Unsupported recording mode`
+  - Use `none`, `session_audio`, `participant_egress`, or `room_composite`.
+- `recording mode 'participant_egress' requires LiveKit server credentials`
+  - Provide `recording.livekit` or set `LIVEKIT_URL`, `LIVEKIT_API_KEY`, and `LIVEKIT_API_SECRET`.
+- `recording mode 'participant_egress' requires deterministic artifact URL resolution`
+  - Provide `recording.s3.public_url_base` or `recording.s3.bucket` + `recording.s3.region`.
+- `recording mode 'participant_egress' requires JobContext`
+  - Pass `job_ctx=ctx` to `hamming.attach_session(...)` or call it from inside the active LiveKit job.

livekit_plugins_hamming-1.5.1/README.md

@@ -0,0 +1,156 @@
+# Hamming plugin for LiveKit Agents
+
+Post-call monitoring for LiveKit Agents with Hamming.
+
+## Installation
+
+Install the plugin from a checked out repository or extracted source archive:
+
+```bash
+python -m pip install ./livekit-plugins/livekit-plugins-hamming
+```
+
+## Pre-requisites
+
+You will need Hamming credentials before configuring the plugin.
+
+- `HAMMING_API_KEY`
+- `HAMMING_EXTERNAL_AGENT_ID`
+
+Credentials can be passed directly or through environment variables.
+
+## Usage
+
+```python
+import os
+
+from livekit.agents import AgentSession, JobContext
+from livekit.plugins import hamming
+
+
+async def entrypoint(ctx: JobContext) -> None:
+    await ctx.connect()
+
+    hamming.configure_hamming(
+        api_key=os.environ["HAMMING_API_KEY"],
+        external_agent_id=os.environ["HAMMING_EXTERNAL_AGENT_ID"],
+        recording={"mode": "session_audio"},
+    )
+
+    session = AgentSession()
+    hamming.attach_session(session, job_ctx=ctx)
+```
+
+## Recording Modes
+
+The plugin supports explicit recording modes through `configure_hamming(recording=...)`.
+If `recording` is omitted, the plugin exports monitoring payloads only and does not start or resolve recordings.
+
+- `none`
+  - Send monitoring payload only.
+- `session_audio`
+  - Use LiveKit session recording and inline `recording_capture` on the final `/collect` payload.
+- `participant_egress`
+  - Start managed LiveKit participant egress and send dual-track recording URLs derived from deterministic output paths.
+- `room_composite`
+  - Start managed LiveKit room composite egress and send a single `recording_url` derived from a deterministic output path.
+
+### Session Audio (Default Simple Path)
+
+```python
+hamming.configure_hamming(
+    api_key=os.environ["HAMMING_API_KEY"],
+    external_agent_id=os.environ["HAMMING_EXTERNAL_AGENT_ID"],
+    recording={"mode": "session_audio"},
+)
+```
+
+### Managed Participant Egress
+
+```python
+hamming.configure_hamming(
+    api_key=os.environ["HAMMING_API_KEY"],
+    external_agent_id=os.environ["HAMMING_EXTERNAL_AGENT_ID"],
+    recording={
+        "mode": "participant_egress",
+        "livekit": {
+            "url": os.environ["LIVEKIT_URL"],
+            "api_key": os.environ["LIVEKIT_API_KEY"],
+            "api_secret": os.environ["LIVEKIT_API_SECRET"],
+        },
+        "s3": {
+            # Required for deterministic artifact URL resolution.
+            "public_url_base": os.environ.get("LIVEKIT_RECORDING_PUBLIC_URL_BASE", ""),
+            # Optional. Include upload credentials only if the plugin should write
+            # directly to S3 instead of relying on LiveKit project defaults.
+            "access_key": os.environ.get("LIVEKIT_RECORDING_S3_ACCESS_KEY", ""),
+            "secret": os.environ.get("LIVEKIT_RECORDING_S3_SECRET", ""),
+            "region": os.environ.get("LIVEKIT_RECORDING_S3_REGION", ""),
+            "bucket": os.environ.get("LIVEKIT_RECORDING_S3_BUCKET", ""),
+        },
+    },
+)
+```
+
+### Managed Room Composite
+
+```python
+hamming.configure_hamming(
+    api_key=os.environ["HAMMING_API_KEY"],
+    external_agent_id=os.environ["HAMMING_EXTERNAL_AGENT_ID"],
+    recording={
+        "mode": "room_composite",
+        "livekit": {
+            "url": os.environ["LIVEKIT_URL"],
+            "api_key": os.environ["LIVEKIT_API_KEY"],
+            "api_secret": os.environ["LIVEKIT_API_SECRET"],
+        },
+        "audio_only": True,
+        "file_type": "ogg",
+    },
+)
+```
+
+Notes:
+
+- Managed remote recording modes require LiveKit server API credentials.
+- Managed remote recording modes also require `job_ctx` when calling `hamming.attach_session(...)`.
+- Managed remote recording modes require deterministic artifact URL resolution via `recording.s3.public_url_base` or `recording.s3.bucket` + `recording.s3.region`.
+- If you provide full S3 credentials, the plugin uses those upload settings for egress output.
+- If you omit S3 upload credentials, your LiveKit project must already have default file output storage configured.
+- The plugin does not poll LiveKit for completed artifact locations; it derives the final public URLs from the configured output path.
+
+## Verify configuration
+
+```python
+import os
+
+from livekit.plugins import hamming
+
+report = hamming.doctor(api_key=os.environ["HAMMING_API_KEY"])
+print(report.to_dict())
+```
+
+## Notes
+
+- Sessions are exported when attached through `hamming.attach_session(...)`.
+- Recording is opt-in. Omitting `recording=...` sends monitoring payloads without recording artifacts.
+- `auto_record_audio=True` is still supported as a backward-compatible alias for `recording={"mode": "session_audio"}`.
+- Managed remote recording modes stop egress on close and send deterministic artifact URLs through the same `/api/rest/v2/collect` ingestion path.
+
+## Troubleshooting
+
+- `RuntimeError: hamming is not configured`
+  - Call `hamming.configure_hamming(...)` before `hamming.attach_session(...)`.
+- `ValueError: Hamming API key required`
+  - Set `HAMMING_API_KEY` or pass `api_key=...`.
+- `external_agent_id is required`
+  - Set `HAMMING_EXTERNAL_AGENT_ID` or pass `external_agent_id=...`.
+- `Unsupported recording mode`
+  - Use `none`, `session_audio`, `participant_egress`, or `room_composite`.
+- `recording mode 'participant_egress' requires LiveKit server credentials`
+  - Provide `recording.livekit` or set `LIVEKIT_URL`, `LIVEKIT_API_KEY`, and `LIVEKIT_API_SECRET`.
+- `recording mode 'participant_egress' requires deterministic artifact URL resolution`
+  - Provide `recording.s3.public_url_base` or `recording.s3.bucket` + `recording.s3.region`.
+- `recording mode 'participant_egress' requires JobContext`
+  - Pass `job_ctx=ctx` to `hamming.attach_session(...)` or call it from inside the active LiveKit job.

livekit_plugins_hamming-1.5.1/livekit/plugins/hamming/__init__.py

@@ -0,0 +1,55 @@
+# Copyright 2026 Hamming, 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.
+
+"""Hamming plugin for LiveKit Agents.
+
+Exports final post-call monitoring artifacts to Hamming.
+"""
+
+from livekit.agents import Plugin
+
+from ._setup import (
+    DoctorReport,
+    attach_session,
+    configure_hamming,
+    doctor,
+    doctor_json,
+)
+from .log import logger
+from .version import __version__
+
+__all__ = [
+    "configure_hamming",
+    "doctor",
+    "doctor_json",
+    "DoctorReport",
+    "attach_session",
+    "__version__",
+]
+
+
+class HammingPlugin(Plugin):
+    def __init__(self) -> None:
+        super().__init__(__name__, __version__, __package__, logger)
+
+
+Plugin.register_plugin(HammingPlugin())
+
+# Cleanup docs of unexported modules
+_module = dir()
+NOT_IN_ALL = [m for m in _module if m not in __all__]
+
+__pdoc__: dict[str, bool] = {}
+for n in NOT_IN_ALL:
+    __pdoc__[n] = False