sockudo-http-python 2.0.0__py3-none-any.whl

sockudo_http_python-2.0.0.dist-info/METADATA

@@ -0,0 +1,191 @@
+Metadata-Version: 2.4
+Name: sockudo-http-python
+Version: 2.0.0
+Summary: High-performance Python HTTP server SDK for Sockudo
+Author: Sockudo
+License-Expression: MIT
+Project-URL: Homepage, https://github.com/sockudo/sockudo/tree/master/server-sdks/sockudo-http-python
+Project-URL: Repository, https://github.com/sockudo/sockudo
+Project-URL: Issues, https://github.com/sockudo/sockudo/issues
+Requires-Python: >=3.9
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: httpx[http2]>=0.27.0
+Requires-Dist: PyNaCl>=1.5.0
+Provides-Extra: dev
+Requires-Dist: build>=1.2.2; extra == "dev"
+Requires-Dist: pytest>=8.0.0; extra == "dev"
+Requires-Dist: pytest-asyncio>=0.23.0; extra == "dev"
+Requires-Dist: ruff>=0.9.0; extra == "dev"
+Requires-Dist: twine>=6.0.0; extra == "dev"
+Dynamic: license-file
+
+# Sockudo Python HTTP Server SDK
+
+High-performance Python server SDK for the Sockudo HTTP API. It publishes events, signs channel and user authentication payloads, validates webhooks, queries channel state, reads durable history, mutates versioned messages, and manages annotations.
+
+## Features
+
+- Sync and asyncio clients: `Sockudo` and `AsyncSockudo`
+- Persistent HTTP connection pooling via `httpx`, with HTTP/2 enabled by default
+- Pusher-compatible signed REST requests
+- Single, multi-channel, and batch publishing
+- Explicit and automatic idempotency keys for safe publish retries
+- Private, presence, user, and webhook authentication helpers
+- Channel state, presence users, durable history, and presence history APIs
+- Versioned message APIs: get, versions, update, delete, append
+- Annotation APIs: publish, list, delete
+- Operator controls for history reset/purge and presence-history reset
+- End-to-end encrypted channel auth, publish, batch publish, and webhook decrypt support for `private-encrypted-*` channels
+
+## Install
+
+For apps, install the published package:
+
+```bash
+pip install sockudo-http-python
+```
+
+For local monorepo development, install from the local path:
+
+```bash
+git clone https://github.com/sockudo/sockudo.git
+pip install -e sockudo/server-sdks/sockudo-http-python
+```
+
+For local development from this monorepo:
+
+```bash
+pip install -e server-sdks/sockudo-http-python[dev]
+```
+
+## Quick Start
+
+```python
+from sockudo_http import Config, Sockudo
+
+sockudo = Sockudo(Config(app_id="app-id", key="app-key", secret="app-secret", host="127.0.0.1", port=6001))
+
+result = sockudo.trigger("orders", "order.created", {"id": "ord_123"})
+assert result.ok
+sockudo.close()
+```
+
+Async:
+
+```python
+from sockudo_http_python import AsyncSockudo, SockudoOptions
+
+async with AsyncSockudo(
+    "app-id",
+    "app-key",
+    "app-secret",
+    options=SockudoOptions(host="127.0.0.1", port=6001),
+) as sockudo:
+    await sockudo.trigger("orders", "order.created", {"id": "ord_123"})
+```
+
+## Idempotent Publishing
+
+```python
+from sockudo_http_python import TriggerOptions
+
+sockudo.trigger(
+    "orders",
+    "order.created",
+    {"id": "ord_123"},
+    TriggerOptions(idempotency_key="order-created-ord_123"),
+)
+
+sockudo.trigger("orders", "order.created", {"id": "ord_124"}, TriggerOptions(idempotency_key=True))
+```
+
+Set `SockudoOptions(auto_idempotency=True)` to generate keys for publish and batch publish calls that omit one.
+
+Target a single user channel:
+
+```python
+sockudo.send_to_user("user-123", "notice", {"body": "hello"})
+```
+
+## Authentication Helpers
+
+```python
+from sockudo_http_python import PresenceUser
+
+private_body = sockudo.authenticate("123.456", "private-orders")
+
+presence_body = sockudo.authenticate(
+    "123.456",
+    "presence-room",
+    PresenceUser("user-1", {"name": "Ada"}),
+)
+
+user_body = sockudo.authenticate_user("123.456", {"id": "user-1", "name": "Ada"})
+```
+
+Encrypted channel auth responses include `shared_secret` when `encryption_master_key_base64` is configured:
+
+```python
+encrypted = Sockudo(
+    "app-id",
+    "app-key",
+    "app-secret",
+    encryption_master_key_base64="base64-encoded-32-byte-key",
+)
+
+body = encrypted.authenticate("123.456", "private-encrypted-room")
+```
+
+## Channel And History APIs
+
+```python
+from sockudo_http_python import ChannelsParams, HistoryParams, PresenceHistoryParams
+
+sockudo.list_channels(ChannelsParams(filter_by_prefix="presence-", info=["subscription_count", "user_count"]))
+sockudo.get_channel_users("presence-room")
+sockudo.get_channel_history("orders", HistoryParams(limit=50, direction="newest_first"))
+sockudo.get_channel_presence_history("presence-room", PresenceHistoryParams(limit=50))
+```
+
+## Versioned Messages And Annotations
+
+```python
+from sockudo_http_python import MessageMutation, PublishAnnotationRequest
+
+sockudo.get_message("orders", "msg:1")
+sockudo.get_message_versions("orders", "msg:1")
+sockudo.update_message("orders", "msg:1", MessageMutation(data={"status": "paid"}))
+sockudo.append_message("orders", "msg:1", " appended text")
+sockudo.delete_message("orders", "msg:1", MessageMutation(description="moderated"))
+
+sockudo.publish_annotation(
+    "orders",
+    "msg:1",
+    PublishAnnotationRequest(type="reactions:distinct.v1", name="like", client_id="user-1", count=1),
+)
+sockudo.list_annotations("orders", "msg:1")
+```
+
+## Webhooks
+
+```python
+validity = sockudo.validate_webhook_signature(x_pusher_key, x_pusher_signature, raw_body)
+webhook = sockudo.parse_webhook(x_pusher_key, x_pusher_signature, raw_body)
+```
+
+If a webhook contains encrypted channel events and the client has an encryption master key, `parse_webhook` decrypts those event payloads.
+
+## Signed URIs
+
+```python
+uri = sockudo.signed_uri("GET", "/apps/app-id/channels", parameters={"filter_by_prefix": "presence-"})
+```
+
+The signing format matches Sockudo/Pusher REST auth: `auth_key`, `auth_timestamp`, `auth_version`, optional `body_md5`, and `auth_signature` over `{METHOD}\n{PATH}\n{SORTED_QUERY}`.
+
+## URL Configuration
+
+```python
+sockudo = Sockudo.from_url("http://app-key:app-secret@127.0.0.1:6001/apps/app-id")
+```

sockudo_http_python-2.0.0.dist-info/RECORD

@@ -0,0 +1,8 @@
+sockudo_http/__init__.py,sha256=YvVKXlTgEp2u7Yf1p7ONWWKg1VauS6bm2dCByaX1s2c,53
+sockudo_http_python/__init__.py,sha256=PsWB_Hn0BzSuM9Y8KNJnLYUWuzloqSwwRH3rIDJOm6o,1145
+sockudo_http_python/client.py,sha256=42_P043iGslDmmjx--Nvpg9endgYItVhQg4DYcWLJkI,60998
+sockudo_http_python-2.0.0.dist-info/licenses/LICENSE,sha256=Rfu09RfZYgdX4dvZwzmFVt2wfFYH87DKhvRy886D8Os,1064
+sockudo_http_python-2.0.0.dist-info/METADATA,sha256=NgCRkr-RXzYDn1uZcLKD8D64F48pGceuccxpbMqj_ck,5922
+sockudo_http_python-2.0.0.dist-info/WHEEL,sha256=aeYiig01lYGDzBgS8HxWXOg3uV61G9ijOsup-k9o1sk,91
+sockudo_http_python-2.0.0.dist-info/top_level.txt,sha256=saTZU7c-zhgTxNxavzQ5c0XSPa5G55wvsQLSq32R_4o,33
+sockudo_http_python-2.0.0.dist-info/RECORD,,

sockudo_http_python-2.0.0.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (82.0.1)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

sockudo_http_python-2.0.0.dist-info/licenses/LICENSE

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

sockudo_http_python-2.0.0.dist-info/top_level.txt

@@ -0,0 +1,2 @@
+sockudo_http
+sockudo_http_python