soniox 2.0.0__tar.gz → 2.2.0__tar.gz

soniox-2.2.0/CHANGELOG.md

@@ -0,0 +1,123 @@
+# Changelog
+
+All notable changes to this project will be documented in this file.
+
+The format is inspired by Keep a Changelog and this project follows Semantic Versioning.
+
+## Quick Guide for Contributors
+
+- Every PR that changes behavior must update **[Unreleased]**.
+- Write from the **user’s perspective** (what changed for SDK users).
+- Keep entries short (one clear sentence).
+- Use the correct section: **Added**, **Changed**, **Fixed**, **Deprecated**, **Removed**, **Security**.
+- Avoid internal details or commit-style messages.
+
+**Release process (maintainers):**
+
+- Rename **[Unreleased]** → new version + date.
+- Add a fresh empty **[Unreleased]** section at the top.
+
+### Version Categories Guide
+
+Use the following categories when adding entries:
+
+- **Added** — new features or capabilities.
+- **Changed** — updates to existing functionality.
+- **Deprecated** — features that will be removed soon.
+- **Removed** — features removed in this version.
+- **Fixed** — bug fixes.
+- **Security** — vulnerability fixes.
+
+---
+
+### Writing Guidelines
+
+- Write entries from the **user's perspective**, not implementation details.
+  - ✅ "Added async file uploads"
+  - ❌ "Refactored upload handler"
+
+- Keep lines short and scannable.
+- Group related changes into one bullet when possible.
+- Avoid commit-message noise.
+- Every released version should have a date.
+
+---
+
+### Versioning Notes
+
+This project follows Semantic Versioning:
+
+- **MAJOR** version when you make incompatible API changes.
+- **MINOR** version when you add functionality in a backward-compatible manner.
+- **PATCH** version when you make backward-compatible bug fixes.
+
+Examples:
+
+- `1.0.0` — stable API
+- `1.1.0` — new features added
+- `1.1.1` — bug fixes only
+
+---
+
+## [Unreleased]
+
+### Added
+
+-
+
+### Changed
+
+-
+
+### Fixed
+
+-
+
+### Removed
+
+---
+
+## [2.2.0] - 25 feb 2026
+
+### Added
+
+- max_endpoint_delay_ms parameter (v4 model only)
+- fin (<fin>) and end (<end>) constants
+- validation for TranslationConfig
+
+### Changed
+
+- Improved docs generating script
+
+---
+
+## [2.1.0] - 18 feb 2026
+
+### Added
+
+- pause and resume methods
+- destroy_all method (removes all transcriptions and all files)
+- send_bytes accepts finish parameter
+
+### Changed
+
+- renamed client.transcriptions to 'client.stt'
+- removed send\_ prefix from methods (i.e. send_keep_alive -> keep_alive)
+
+### Removed
+
+- keep alive helpers (use pause, resume, or manually send keepalive message)
+
+---
+
+## [2.0.0] - 3 feb 2026
+
+### Added
+
+- Initial public release of the Python SDK.
+- Core client implementation (sync and async).
+- Full support for REST API and websocket API
+
+### Removed
+
+- Old Soniox Python SDK (versions 1._._)

{soniox-2.0.0 → soniox-2.2.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: soniox
-Version: 2.0.0
+Version: 2.2.0
 Summary: The official Python SDK for the Soniox API (STT, REST)
 Project-URL: Homepage, https://sonoix.com
 Project-URL: Documentation, https://soniox.com/docs
@@ -30,14 +30,15 @@ Requires-Dist: httpx>0.25.0
 Requires-Dist: pydantic>2
 Requires-Dist: websockets>11.0
 Provides-Extra: dev
-Requires-Dist: pydoc-markdown>=4.8.2; extra == 'dev'
+Requires-Dist: griffe>=1.15.0; extra == 'dev'
 Requires-Dist: pyright>=1.1.0; extra == 'dev'
 Requires-Dist: ruff>=0.0.0; extra == 'dev'
 Description-Content-Type: text/markdown
 
 # Soniox Python SDK
 
-The SDK exposes two clients: `SonioxClient` (sync) and `AsyncSonioxClient`. Client can hit every Soniox REST endpoint or open a realtime websocket session without wiring headers, retries, or payload validation yourself. Auth, file uploads, transcription polling, webhook helpers, and realtime stream helpers all live in one typed package.
+The SDK exposes two clients: `SonioxClient` (sync) and `AsyncSonioxClient`. Client can hit every Soniox REST endpoint or open a real-time websocket session, so you can focus on building features instead of dealing with boilerplate.
+Auth, file uploads, transcription polling, webhook helpers, and real-time stream helpers all live in one typed package.
 
 ## Install
 
@@ -50,7 +51,7 @@ export SONIOX_API_KEY=<your-key>
 
 Get your API key from the [Soniox Console](https://console.soniox.com) and inject it once per shell session. Both clients read `SONIOX_API_KEY` by default, but you can override it per-client if needed.
 
-## Quick run (rest + realtime)
+## Quick run (rest + real-time)
 
 1. **REST transcription**: copy this snippet or run [`examples/soniox_client/api_example.py`](https://github.com/soniox/soniox-python/blob/main/examples/soniox_client/api_example.py).
 
@@ -58,15 +59,15 @@ Get your API key from the [Soniox Console](https://console.soniox.com) and injec
 from soniox import SonioxClient
 
 client = SonioxClient()
-transcription = client.transcriptions.transcribe(
+transcription = client.stt.transcribe(
     audio_url="https://soniox.com/media/examples/coffee_shop.mp3",
     client_reference_id="docs-quick-start",
 )
-client.transcriptions.wait(transcription.id, timeout_sec=60)
-print(client.transcriptions.get_transcript(transcription.id).text[:200])
+client.stt.wait(transcription.id, timeout_sec=60)
+print(client.stt.get_transcript(transcription.id).text[:200])
 ```
 
-2. **Realtime streaming**: the realtime helpers mirror the sync rest sample—open `client.realtime.stt.connect`, call `session.send_byte_chunk` or `session.send_bytes`, then iterate `session.receive_events()` to render tokens. example:
+2. **Real-time streaming**: the real-time helpers mirror the sync rest sample—open `client.realtime.stt.connect`, call `session.send_byte_chunk` or `session.send_bytes`, then iterate `session.receive_events()` to render tokens. example:
 
 ```python
 from soniox import SonioxClient
@@ -76,7 +77,7 @@ from soniox.utils import render_tokens, throttle_audio, start_audio_thread
 DEMO_FILE = "path_to_your_audio_file"
 
 client = SonioxClient()
-config = RealtimeSTTConfig(model="stt-rt-v3", audio_format="mp3")
+config = RealtimeSTTConfig(model="stt-rt-v4", audio_format="mp3")
 final_tokens: list[Token] = []
 non_final_tokens: list[Token] = []
 
@@ -99,9 +100,9 @@ see [`examples/soniox_client/realtime_example.py`](https://github.com/soniox/son
 
 ## Repository layout
 
-- `src/soniox/` – sdk code (clients, http namespaces, realtime/session helpers, types, utils).
-- `examples/soniox_client` & `examples/async_soniox_client` – runnable rest + realtime flows for sync and async.
-- `docs/` – folder where `pydoc-markdown` command generates full sdk reference markdown file.
+- `src/soniox/` – sdk code (clients, http namespaces, real-time/session helpers, types, utils).
+- `examples/soniox_client` & `examples/async_soniox_client` – runnable rest + real-time flows for sync and async.
+- `docs/` – markdown outputs (e.g., `docs/python-sdk.md`) that come from `pydoc-markdown`.
 - `assets/` – sample audio referenced by the examples.
 - `tests/` – pytest narratives that describe the public behavior.
 
@@ -111,11 +112,20 @@ see [`examples/soniox_client/realtime_example.py`](https://github.com/soniox/son
 uv install --with dev
 ```
 
-This pulls in `ruff`, `pyright`, `pytest`, `pydoc-markdown`, etc., so you can lint, type-check, test, and regenerate docs locally.
+This pulls in `ruff`, `pyright`, `pytest`, etc., so you can lint, type-check, test, and regenerate docs locally.
+
+## Docs
+
+```bash
+source .venv/bin/activate
+python3 scripts/generate_docs.py
+```
+
+Docs are output to `/docs` directory.
 
 ## Resources
 
-- [soniox.com/docs](https://soniox.com/docs) – official Soniox documentation.
+- [soniox.com/docs](https://soniox.com/docs/stt/SDKs/python-SDK) – official Soniox documentation.
 - [GitHub repo](https://github.com/soniox/soniox-python) – source, examples, and scripts.
 - [PyPI](https://pypi.org/project/soniox/)
 - Support: `support@soniox.com`.

{soniox-2.0.0 → soniox-2.2.0}/README.md

@@ -1,6 +1,7 @@
 # Soniox Python SDK
 
-The SDK exposes two clients: `SonioxClient` (sync) and `AsyncSonioxClient`. Client can hit every Soniox REST endpoint or open a realtime websocket session without wiring headers, retries, or payload validation yourself. Auth, file uploads, transcription polling, webhook helpers, and realtime stream helpers all live in one typed package.
+The SDK exposes two clients: `SonioxClient` (sync) and `AsyncSonioxClient`. Client can hit every Soniox REST endpoint or open a real-time websocket session, so you can focus on building features instead of dealing with boilerplate.
+Auth, file uploads, transcription polling, webhook helpers, and real-time stream helpers all live in one typed package.
 
 ## Install
 
@@ -13,7 +14,7 @@ export SONIOX_API_KEY=<your-key>
 
 Get your API key from the [Soniox Console](https://console.soniox.com) and inject it once per shell session. Both clients read `SONIOX_API_KEY` by default, but you can override it per-client if needed.
 
-## Quick run (rest + realtime)
+## Quick run (rest + real-time)
 
 1. **REST transcription**: copy this snippet or run [`examples/soniox_client/api_example.py`](https://github.com/soniox/soniox-python/blob/main/examples/soniox_client/api_example.py).
 
@@ -21,15 +22,15 @@ Get your API key from the [Soniox Console](https://console.soniox.com) and injec
 from soniox import SonioxClient
 
 client = SonioxClient()
-transcription = client.transcriptions.transcribe(
+transcription = client.stt.transcribe(
     audio_url="https://soniox.com/media/examples/coffee_shop.mp3",
     client_reference_id="docs-quick-start",
 )
-client.transcriptions.wait(transcription.id, timeout_sec=60)
-print(client.transcriptions.get_transcript(transcription.id).text[:200])
+client.stt.wait(transcription.id, timeout_sec=60)
+print(client.stt.get_transcript(transcription.id).text[:200])
 ```
 
-2. **Realtime streaming**: the realtime helpers mirror the sync rest sample—open `client.realtime.stt.connect`, call `session.send_byte_chunk` or `session.send_bytes`, then iterate `session.receive_events()` to render tokens. example:
+2. **Real-time streaming**: the real-time helpers mirror the sync rest sample—open `client.realtime.stt.connect`, call `session.send_byte_chunk` or `session.send_bytes`, then iterate `session.receive_events()` to render tokens. example:
 
 ```python
 from soniox import SonioxClient
@@ -39,7 +40,7 @@ from soniox.utils import render_tokens, throttle_audio, start_audio_thread
 DEMO_FILE = "path_to_your_audio_file"
 
 client = SonioxClient()
-config = RealtimeSTTConfig(model="stt-rt-v3", audio_format="mp3")
+config = RealtimeSTTConfig(model="stt-rt-v4", audio_format="mp3")
 final_tokens: list[Token] = []
 non_final_tokens: list[Token] = []
 
@@ -62,9 +63,9 @@ see [`examples/soniox_client/realtime_example.py`](https://github.com/soniox/son
 
 ## Repository layout
 
-- `src/soniox/` – sdk code (clients, http namespaces, realtime/session helpers, types, utils).
-- `examples/soniox_client` & `examples/async_soniox_client` – runnable rest + realtime flows for sync and async.
-- `docs/` – folder where `pydoc-markdown` command generates full sdk reference markdown file.
+- `src/soniox/` – sdk code (clients, http namespaces, real-time/session helpers, types, utils).
+- `examples/soniox_client` & `examples/async_soniox_client` – runnable rest + real-time flows for sync and async.
+- `docs/` – markdown outputs (e.g., `docs/python-sdk.md`) that come from `pydoc-markdown`.
 - `assets/` – sample audio referenced by the examples.
 - `tests/` – pytest narratives that describe the public behavior.
 
@@ -74,11 +75,20 @@ see [`examples/soniox_client/realtime_example.py`](https://github.com/soniox/son
 uv install --with dev
 ```
 
-This pulls in `ruff`, `pyright`, `pytest`, `pydoc-markdown`, etc., so you can lint, type-check, test, and regenerate docs locally.
+This pulls in `ruff`, `pyright`, `pytest`, etc., so you can lint, type-check, test, and regenerate docs locally.
+
+## Docs
+
+```bash
+source .venv/bin/activate
+python3 scripts/generate_docs.py
+```
+
+Docs are output to `/docs` directory.
 
 ## Resources
 
-- [soniox.com/docs](https://soniox.com/docs) – official Soniox documentation.
+- [soniox.com/docs](https://soniox.com/docs/stt/SDKs/python-SDK) – official Soniox documentation.
 - [GitHub repo](https://github.com/soniox/soniox-python) – source, examples, and scripts.
 - [PyPI](https://pypi.org/project/soniox/)
 - Support: `support@soniox.com`.