borgee-plugin-sdk 0.1.2__tar.gz

borgee_plugin_sdk-0.1.2/LICENSE

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

borgee_plugin_sdk-0.1.2/PKG-INFO

@@ -0,0 +1,72 @@
+Metadata-Version: 2.4
+Name: borgee-plugin-sdk
+Version: 0.1.2
+Summary: Async Python SDK for Borgee plugin runtimes
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Python: <3.14,>=3.11
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: websockets==15.0.1
+Provides-Extra: test
+Requires-Dist: build==1.2.2.post1; extra == "test"
+Requires-Dist: mypy==1.17.0; extra == "test"
+Requires-Dist: PyYAML==6.0.2; extra == "test"
+Requires-Dist: pytest==9.0.3; extra == "test"
+Requires-Dist: pytest-asyncio==1.3.0; extra == "test"
+Requires-Dist: pytest-timeout==2.4.0; extra == "test"
+Requires-Dist: ruff==0.12.4; extra == "test"
+Requires-Dist: twine==6.1.0; extra == "test"
+Dynamic: license-file
+
+# Borgee Plugin SDK for Python
+
+`borgee-plugin-sdk` connects a Python runtime to Borgee over the Borgee Plugin
+Protocol (BPP). It supports Python 3.11 through 3.13 and pins
+`websockets==15.0.1` because the connection hardening depends on that exact
+client implementation.
+
+Build a wheel from this directory or install the source checkout for evaluation. The repository also provides a manual workflow for publishing to TestPyPI and PyPI.
+
+```bash
+python -m pip install .
+```
+
+```python
+import asyncio
+
+from borgee_plugin_sdk import BorgeePluginOptions, ReplayMode, create_borgee_plugin
+
+
+async def main() -> None:
+    client = create_borgee_plugin(
+        BorgeePluginOptions(
+            base_url="https://chat.example.com",
+            api_key="bgr_example",
+            replay_mode=ReplayMode.LATEST_N,
+        )
+    )
+    async with client:
+        async for delivery in client.deliveries():
+            print(delivery.event)
+            await delivery.checkpoint()
+
+
+asyncio.run(main())
+```
+
+Every inbound message or replay summary is a `Delivery`. The iterator has one
+consumer, and it will not advance until the consumer calls `checkpoint()` or
+`fail()`. Actions fail while the connection is resuming; replay consumption
+continues until the client becomes online.
+
+For local development, insecure transport is restricted to loopback origins and
+requires `allow_insecure_loopback=True`. API keys are sent only in the WebSocket
+`Authorization` header. Redirects are rejected.
+
+This package is licensed under the MIT License.

borgee_plugin_sdk-0.1.2/README.md

@@ -0,0 +1,46 @@
+# Borgee Plugin SDK for Python
+
+`borgee-plugin-sdk` connects a Python runtime to Borgee over the Borgee Plugin
+Protocol (BPP). It supports Python 3.11 through 3.13 and pins
+`websockets==15.0.1` because the connection hardening depends on that exact
+client implementation.
+
+Build a wheel from this directory or install the source checkout for evaluation. The repository also provides a manual workflow for publishing to TestPyPI and PyPI.
+
+```bash
+python -m pip install .
+```
+
+```python
+import asyncio
+
+from borgee_plugin_sdk import BorgeePluginOptions, ReplayMode, create_borgee_plugin
+
+
+async def main() -> None:
+    client = create_borgee_plugin(
+        BorgeePluginOptions(
+            base_url="https://chat.example.com",
+            api_key="bgr_example",
+            replay_mode=ReplayMode.LATEST_N,
+        )
+    )
+    async with client:
+        async for delivery in client.deliveries():
+            print(delivery.event)
+            await delivery.checkpoint()
+
+
+asyncio.run(main())
+```
+
+Every inbound message or replay summary is a `Delivery`. The iterator has one
+consumer, and it will not advance until the consumer calls `checkpoint()` or
+`fail()`. Actions fail while the connection is resuming; replay consumption
+continues until the client becomes online.
+
+For local development, insecure transport is restricted to loopback origins and
+requires `allow_insecure_loopback=True`. API keys are sent only in the WebSocket
+`Authorization` header. Redirects are rejected.
+
+This package is licensed under the MIT License.

borgee_plugin_sdk-0.1.2/pyproject.toml

@@ -0,0 +1,58 @@
+[build-system]
+requires = ["setuptools>=77.0,<83", "wheel"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "borgee-plugin-sdk"
+version = "0.1.2"
+description = "Async Python SDK for Borgee plugin runtimes"
+readme = "README.md"
+license = "MIT"
+license-files = ["LICENSE"]
+requires-python = ">=3.11,<3.14"
+dependencies = ["websockets==15.0.1"]
+classifiers = [
+  "Development Status :: 3 - Alpha",
+  "Programming Language :: Python :: 3",
+  "Programming Language :: Python :: 3.11",
+  "Programming Language :: Python :: 3.12",
+  "Programming Language :: Python :: 3.13",
+  "Typing :: Typed",
+]
+
+[project.optional-dependencies]
+test = [
+  "build==1.2.2.post1",
+  "mypy==1.17.0",
+  "PyYAML==6.0.2",
+  "pytest==9.0.3",
+  "pytest-asyncio==1.3.0",
+  "pytest-timeout==2.4.0",
+  "ruff==0.12.4",
+  "twine==6.1.0",
+]
+
+[tool.setuptools]
+package-dir = {"" = "src"}
+
+[tool.setuptools.packages.find]
+where = ["src"]
+
+[tool.pytest.ini_options]
+addopts = "--strict-markers --timeout=30 --timeout-method=signal"
+asyncio_mode = "auto"
+testpaths = ["tests"]
+markers = ["e2e: cross-process tests that build and start the real Go server"]
+
+[tool.ruff]
+target-version = "py311"
+line-length = 110
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "UP", "B", "ASYNC", "RUF"]
+
+[tool.mypy]
+python_version = "3.11"
+strict = true
+warn_unreachable = true
+packages = ["borgee_plugin_sdk"]

borgee_plugin_sdk-0.1.2/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

borgee_plugin_sdk-0.1.2/src/borgee_plugin_sdk/__init__.py

@@ -0,0 +1,83 @@
+"""Public API for the Borgee Python plugin SDK."""
+
+from ._connection import Delivery
+from .client import BorgeePluginClient, BorgeePluginOptions, create_borgee_plugin
+from .cursor import CursorStore, FileCursorStore, MemoryCursorStore
+from .errors import (
+    BorgeeError,
+    CursorStoreError,
+    NotOnlineError,
+    PermissionDeniedError,
+    PreResumeError,
+    ProtocolCapacityError,
+    ProtocolError,
+    ResumeAckError,
+    StaleDeliveryError,
+)
+from .models import (
+    MISSING,
+    ConfigApplyContext,
+    ConfigApplyResult,
+    ConfigApplyStatus,
+    ConfigUpdate,
+    ConnectionState,
+    ConnectionStatus,
+    CreatedDM,
+    FaultReason,
+    InboundKind,
+    InboundMessageEvent,
+    InboundReaction,
+    Message,
+    ReplayMode,
+    ReplaySummaryEvent,
+    ResponseFrame,
+    SentMessage,
+    Task,
+    TaskOutcome,
+    User,
+    UserRole,
+    task_from_wire,
+)
+
+__version__ = "0.1.2"
+
+__all__ = [
+    "MISSING",
+    "BorgeeError",
+    "BorgeePluginClient",
+    "BorgeePluginOptions",
+    "ConfigApplyContext",
+    "ConfigApplyResult",
+    "ConfigApplyStatus",
+    "ConfigUpdate",
+    "ConnectionState",
+    "ConnectionStatus",
+    "CreatedDM",
+    "CursorStore",
+    "CursorStoreError",
+    "Delivery",
+    "FaultReason",
+    "FileCursorStore",
+    "InboundKind",
+    "InboundMessageEvent",
+    "InboundReaction",
+    "MemoryCursorStore",
+    "Message",
+    "NotOnlineError",
+    "PermissionDeniedError",
+    "PreResumeError",
+    "ProtocolCapacityError",
+    "ProtocolError",
+    "ReplayMode",
+    "ReplaySummaryEvent",
+    "ResponseFrame",
+    "ResumeAckError",
+    "SentMessage",
+    "StaleDeliveryError",
+    "Task",
+    "TaskOutcome",
+    "User",
+    "UserRole",
+    "create_borgee_plugin",
+    "task_from_wire",
+]