spatius 1.0.0__tar.gz

spatius-1.0.0/.github/workflows/publish-testpypi.yml

@@ -0,0 +1,40 @@
+name: Publish to TestPyPI
+
+on:
+  workflow_dispatch:
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    name: Build and publish to TestPyPI
+    runs-on: ubuntu-latest
+    environment: testpypi
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.1.0
+        with:
+          version: "latest"
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to TestPyPI
+        uses: pypa/gh-action-pypi-publish@release/v1
+        with:
+          repository-url: https://test.pypi.org/legacy/

spatius-1.0.0/.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+name: Publish to PyPI
+
+on:
+  release:
+    types: [published]
+
+permissions:
+  contents: read
+
+jobs:
+  publish:
+    name: Build and publish to PyPI
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      contents: read
+      id-token: write
+
+    steps:
+      - name: Checkout code
+        uses: actions/checkout@v6
+        with:
+          fetch-depth: 0
+
+      - name: Set up Python
+        uses: actions/setup-python@v6
+        with:
+          python-version: '3.14'
+
+      - name: Install uv
+        uses: astral-sh/setup-uv@v8.1.0
+        with:
+          version: "latest"
+
+      - name: Build package
+        run: uv build
+
+      - name: Publish to PyPI
+        uses: pypa/gh-action-pypi-publish@release/v1

spatius-1.0.0/.github/workflows/test.yml

@@ -0,0 +1,35 @@
+name: Test
+
+on:
+  push:
+    branches: [ main ]
+  pull_request:
+    branches: [ main ]
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      fail-fast: false
+      matrix:
+        os: [ubuntu-latest, macos-latest, windows-latest]
+        python-version: ['3.9', '3.10', '3.11', '3.12', '3.13', '3.14']
+
+    steps:
+    - uses: actions/checkout@v6
+
+    - name: Set up Python ${{ matrix.python-version }}
+      uses: actions/setup-python@v6
+      with:
+        python-version: ${{ matrix.python-version }}
+
+    - name: Install uv
+      uses: astral-sh/setup-uv@v8.1.0
+      with:
+        enable-cache: true
+
+    - name: Install dependencies
+      run: uv sync
+
+    - name: Run tests
+      run: uv run pytest

spatius-1.0.0/.gitignore

@@ -0,0 +1,216 @@
+# Byte-compiled / optimized / DLL files
+__pycache__/
+*.py[codz]
+*$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
+
+# UV
+#   Similar to Pipfile.lock, it is generally recommended to include uv.lock in version control.
+#   This is especially recommended for binary packages to ensure reproducibility, and is more
+#   commonly ignored for libraries.
+# uv.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
+# poetry.toml
+
+# pdm
+#   Similar to Pipfile.lock, it is generally recommended to include pdm.lock in version control.
+#   pdm recommends including project-wide configuration in pdm.toml, but excluding .pdm-python.
+#   https://pdm-project.org/en/latest/usage/project/#working-with-version-control
+# pdm.lock
+# pdm.toml
+.pdm-python
+.pdm-build/
+
+# pixi
+#   Similar to Pipfile.lock, it is generally recommended to include pixi.lock in version control.
+# pixi.lock
+#   Pixi creates a virtual environment in the .pixi directory, just like venv module creates one
+#   in the .venv directory. It is recommended not to include this directory in version control.
+.pixi
+
+# PEP 582; used by e.g. github.com/David-OConnor/pyflow and github.com/pdm-project/pdm
+__pypackages__/
+
+# Celery stuff
+celerybeat-schedule
+celerybeat.pid
+
+# Redis
+*.rdb
+*.aof
+*.pid
+
+# RabbitMQ
+mnesia/
+rabbitmq/
+rabbitmq-data/
+
+# ActiveMQ
+activemq-data/
+
+# SageMath parsed files
+*.sage.py
+
+# Environments
+.env
+.envrc
+.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/
+
+# Abstra
+#   Abstra is an AI-powered process automation framework.
+#   Ignore directories containing user credentials, local state, and settings.
+#   Learn more at https://abstra.io/docs
+.abstra/
+
+# Visual Studio Code
+#   Visual Studio Code specific template is maintained in a separate VisualStudioCode.gitignore 
+#   that can be found at https://github.com/github/gitignore/blob/main/Global/VisualStudioCode.gitignore
+#   and can be added to the global gitignore or merged into this file. However, if you prefer, 
+#   you could uncomment the following to ignore the entire vscode folder
+# .vscode/
+
+# Ruff stuff:
+.ruff_cache/
+
+# PyPI configuration file
+.pypirc
+
+# Marimo
+marimo/_static/
+marimo/_lsp/
+__marimo__/
+
+# Streamlit
+.streamlit/secrets.toml

spatius-1.0.0/.python-version

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

spatius-1.0.0/AGENTS.md

@@ -0,0 +1,127 @@
+# AGENTS.md
+
+This file provides guidance to coding agents when working with code in this repository.
+
+## Build and Development Commands
+
+```bash
+# Install dependencies
+uv sync
+
+# Run tests
+pytest
+
+# Run a single test file
+pytest tests/test_avatar_session_v2.py
+
+# Run a specific test
+pytest tests/test_avatar_session_v2.py::TestAvatarSessionV2::test_init_success
+
+# Test across multiple Python versions locally
+./test-local.sh all          # Test all Python versions (3.9-3.13) with all dependency combinations
+./test-local.sh py39         # Test Python 3.9 only
+./test-local.sh min          # Test minimum dependency versions on all Python versions
+./test-local.sh latest       # Test latest dependency versions on all Python versions
+./test-local.sh quick        # Quick test on current Python version
+
+# Regenerate protobuf code (after modifying proto/message.proto)
+cd proto && buf generate
+```
+
+## Architecture
+
+This is a Python SDK for WebSocket-based avatar services with audio streaming and animation frame reception. Published as `spatius` on PyPI.
+
+### Core Components
+
+- **`avatar_session.py`** - Main `AvatarSession` class managing WebSocket connections, audio streaming, and frame reception. Uses v2 protocol with HTTP-based session token acquisition followed by WebSocket handshake. Exports `SessionTokenError` for token acquisition failures.
+
+- **`session_config.py`** - `SessionConfig` dataclass, `LiveKitEgressConfig` dataclass, `AgoraEgressConfig` dataclass, and typed `new_avatar_session()` factory for session configuration.
+
+- **`errors.py`** - `AvatarSDKError` exception with stable error codes (`AvatarSDKErrorCode` enum). Error codes: `sessionTokenExpired`, `sessionTokenInvalid`, `appIDUnrecognized`, `unknown`.
+
+- **`logid.py`** - `generate_log_id()` utility for generating unique log IDs in format "YYYYMMDDHHMMSS_<nanoid>".
+
+- **`proto/generated/`** - Auto-generated protobuf code from `proto/message.proto`. Message types: ClientConfigureSession, ServerConfirmSession, ClientAudioInput, ServerError, ServerResponseAnimation, ClientInterrupt.
+
+### Session Flow
+
+1. `new_avatar_session()` creates configuration
+2. `session.init()` - HTTP POST to console API for session token
+3. `session.start()` - WebSocket connection + v2 handshake, returns connection_id
+4. `session.send_audio()` - Send PCM audio via protobuf
+5. Background read loop delivers animation frames via `transport_frames` callback
+6. `session.close()` - Cleanup
+
+### Audio Format
+
+Mono 16-bit PCM (s16le) only. Supported sample rates: 8000, 16000, 22050, 24000, 32000, 44100, 48000 Hz.
+
+### Authentication
+
+Two modes controlled by `use_query_auth`:
+- `False` (default): Headers-based auth (mobile pattern)
+- `True`: Query params-based auth (web pattern)
+
+### LiveKit Egress Mode
+
+When configured with `livekit_egress`, audio and animation data are streamed to a LiveKit room via the egress service instead of being returned through the WebSocket connection. The egress configuration is sent via the `ClientConfigureSession` proto message.
+
+To use LiveKit egress mode:
+1. Configure the session with `livekit_egress=LiveKitEgressConfig(...)`
+2. Provide LiveKit connection details: url, api_key, api_secret, room_name, and publisher_id
+3. The server will create an egress connection and stream output to the LiveKit room
+4. The `transport_frames` callback will not be invoked since data goes to LiveKit
+
+```python
+from spatius import new_avatar_session, LiveKitEgressConfig
+
+session = new_avatar_session(
+    livekit_egress=LiveKitEgressConfig(
+        url="wss://livekit.example.com",
+        api_key="your-api-key",
+        api_secret="your-api-secret",
+        room_name="room-name",
+        publisher_id="publisher-id",
+    ),
+    # ... other options
+)
+```
+
+### Agora Egress Mode
+
+When configured with `agora_egress`, audio and animation data are streamed to an Agora channel via the egress service instead of being returned through the WebSocket connection. The egress configuration is sent via the `ClientConfigureSession` proto message.
+
+To use Agora egress mode:
+1. Configure the session with `agora_egress=AgoraEgressConfig(...)`
+2. Provide Agora connection details: channel_name, token (optional for testing), uid (0 for auto-assign), and publisher_id
+3. The server will create an egress connection and stream output to the Agora channel
+4. The `transport_frames` callback will not be invoked since data goes to Agora
+
+```python
+from spatius import new_avatar_session, AgoraEgressConfig
+
+session = new_avatar_session(
+    agora_egress=AgoraEgressConfig(
+        channel_name="channel-name",
+        token="your-agora-token",  # optional for testing
+        uid=0,  # 0 for auto-assign
+        publisher_id="publisher-id",
+    ),
+    # ... other options
+)
+```
+
+### Interrupt Functionality (Egress Mode Only)
+
+The `interrupt()` method sends an interrupt signal to stop current audio processing. This is available when using egress mode (LiveKit or Agora).
+
+```python
+# Send some audio
+req_id = await session.send_audio(audio_data, end=True)
+
+# Interrupt if needed (e.g., user wants to stop)
+interrupted_id = await session.interrupt()
+```
+
+The interrupt uses `last_req_id` which tracks the most recent request, even after `end=True` was sent. This allows interrupting requests that have finished sending audio but are still being processed.

spatius-1.0.0/CLAUDE.md

@@ -0,0 +1 @@
+AGENTS.md

spatius-1.0.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2026 spatialwalk
+
+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.

spatius-1.0.0/PKG-INFO

@@ -0,0 +1,86 @@
+Metadata-Version: 2.4
+Name: spatius
+Version: 1.0.0
+Summary: Python SDK for avatar WebSocket services with audio streaming and animation frame reception
+Author-email: 3DRX <3drxkjy@gmail.com>
+License-File: LICENSE
+Keywords: animation,audio,avatar,protobuf,sdk,websocket
+Classifier: Development Status :: 5 - Production/Stable
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Programming Language :: Python :: 3.14
+Requires-Python: >=3.9
+Requires-Dist: aiohttp>=3.9.0
+Requires-Dist: nanoid>=2.0.0
+Requires-Dist: protobuf>=5.28.3
+Requires-Dist: websockets>=10.0
+Provides-Extra: opus
+Requires-Dist: opuslib>=3.0.1; extra == 'opus'
+Description-Content-Type: text/markdown
+
+# Spatius Python SDK
+
+Python server SDK for creating Spatius avatar sessions.
+
+## Installation
+
+```bash
+pip install spatius
+```
+
+Install the optional Ogg Opus encoder support when you want the SDK to encode raw PCM before sending:
+
+```bash
+pip install "spatius[opus]"
+```
+
+## Quick Start
+
+```python
+import asyncio
+from datetime import datetime, timedelta, timezone
+
+from spatius import new_avatar_session
+
+
+async def main():
+    session = new_avatar_session(
+        api_key="your-api-key",
+        app_id="your-app-id",
+        avatar_id="your-avatar-id",
+        expire_at=datetime.now(timezone.utc) + timedelta(minutes=5),
+        transport_frames=lambda frame, last: print(
+            f"Received frame: {len(frame)} bytes, last={last}"
+        ),
+        on_error=lambda err: print(f"Session error: {err}"),
+        on_close=lambda: print("Session closed"),
+    )
+
+    await session.init()
+    connection_id = await session.start()
+    print(f"Connected: {connection_id}")
+
+    audio_data = b"..."  # mono PCM s16le audio bytes
+    request_id = await session.send_audio(audio_data, end=True)
+    print(f"Sent audio request: {request_id}")
+
+    await asyncio.sleep(10)
+    await session.close()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Documentation
+
+See the full Python SDK guide at [docs.spatius.ai/sdk-reference/python-sdk/python-sdk](https://docs.spatius.ai/sdk-reference/python-sdk/python-sdk).
+
+## License
+
+MIT

spatius-1.0.0/README.md

@@ -0,0 +1,61 @@
+# Spatius Python SDK
+
+Python server SDK for creating Spatius avatar sessions.
+
+## Installation
+
+```bash
+pip install spatius
+```
+
+Install the optional Ogg Opus encoder support when you want the SDK to encode raw PCM before sending:
+
+```bash
+pip install "spatius[opus]"
+```
+
+## Quick Start
+
+```python
+import asyncio
+from datetime import datetime, timedelta, timezone
+
+from spatius import new_avatar_session
+
+
+async def main():
+    session = new_avatar_session(
+        api_key="your-api-key",
+        app_id="your-app-id",
+        avatar_id="your-avatar-id",
+        expire_at=datetime.now(timezone.utc) + timedelta(minutes=5),
+        transport_frames=lambda frame, last: print(
+            f"Received frame: {len(frame)} bytes, last={last}"
+        ),
+        on_error=lambda err: print(f"Session error: {err}"),
+        on_close=lambda: print("Session closed"),
+    )
+
+    await session.init()
+    connection_id = await session.start()
+    print(f"Connected: {connection_id}")
+
+    audio_data = b"..."  # mono PCM s16le audio bytes
+    request_id = await session.send_audio(audio_data, end=True)
+    print(f"Sent audio request: {request_id}")
+
+    await asyncio.sleep(10)
+    await session.close()
+
+
+if __name__ == "__main__":
+    asyncio.run(main())
+```
+
+## Documentation
+
+See the full Python SDK guide at [docs.spatius.ai/sdk-reference/python-sdk/python-sdk](https://docs.spatius.ai/sdk-reference/python-sdk/python-sdk).
+
+## License
+
+MIT