relayfile-sdk 0.2.1__tar.gz

relayfile_sdk-0.2.1/.gitignore

@@ -0,0 +1,77 @@
+# Go
+*.exe
+*.exe~
+*.dll
+*.so
+*.dylib
+*.test
+*.out
+.gocache/
+
+# State files
+*.state.json
+*.state.json.tmp
+
+# IDE
+.idea/
+.vscode/
+*.swp
+*.swo
+
+# OS
+.DS_Store
+Thumbs.db
+
+.agent-relay/
+.relay/
+.relayfile/evals/runs/
+evals/suites/*/cases.jsonl
+
+# Node (SDK)
+node_modules/
+.npm-cache/
+dist/
+*.tsbuildinfo
+
+# Python
+__pycache__/
+*.pyc
+*.egg-info/
+.pytest_cache/
+
+# Environment
+.env
+.env.*
+
+# Local mount mirror
+/.livefs/
+
+# Compiled binaries
+bin/
+/relayfile
+/relayfile-cli
+/relayfile-mount
+/relayfile-server
+
+# Mount platform packages: keep the skeleton (package.json/README/bin/.gitkeep)
+# tracked, but never commit the prebuilt binary copied in at release time.
+# (The blanket `bin/` rule above would otherwise ignore these dirs entirely.)
+!packages/mount-*/bin/
+!packages/mount-*/bin/.gitkeep
+packages/mount-*/bin/relayfile-mount
+
+# Agent tool configs
+.factory/
+.gemini/
+.mcp.json
+opencode.json
+site/node_modules/
+site/dist/
+
+# observer
+.next/
+packages/file-observer/out/
+packages/agents/dist
+.scratch/
+.agentworkforce/
+packages/**/.claude/

relayfile_sdk-0.2.1/AGENTS.md

@@ -0,0 +1,12 @@
+# Python SDK
+
+Keep the Python SDK idiomatic and in parity with the TypeScript surface.
+
+- Prefer snake_case names for Python-specific APIs; only keep camelCase when mirroring HTTP JSON keys from the wire format.
+- Re-export public SDK symbols from `src/relayfile/__init__.py` whenever you add or remove client types, errors, or provider helpers.
+- Maintain both sync and async client behavior when adding endpoints or retry/error handling.
+- Test HTTP behavior with `pytest`, `pytest-asyncio`, `respx`, and `httpx.Response` mocks under `tests/`.
+- Verify with `pytest packages/sdk/python/tests`.
+- Workspace primitive SDK changes should remain additive: mirror the TypeScript
+  type surface, expose path helpers for digest/layout/schema virtual files, and
+  avoid adding client methods until the HTTP OpenAPI contract exists.

relayfile_sdk-0.2.1/PKG-INFO

@@ -0,0 +1,85 @@
+Metadata-Version: 2.4
+Name: relayfile-sdk
+Version: 0.2.1
+Summary: Python SDK for the RelayFile virtual filesystem API
+License-Expression: Apache-2.0
+Requires-Python: >=3.10
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: websocket-client<2,>=1.7
+Provides-Extra: dev
+Requires-Dist: pytest-asyncio>=0.24; extra == 'dev'
+Requires-Dist: pytest>=8; extra == 'dev'
+Requires-Dist: respx>=0.22; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# relayfile
+
+Python SDK for the RelayFile virtual filesystem API.
+
+## Install
+
+```bash
+pip install relayfile-sdk
+```
+
+The import namespace remains `relayfile`.
+
+## Workspace Primitives (M1)
+
+The SDK exposes the workspace primitive paths and data shapes used by digest,
+layout, schema, and writeback tooling.
+
+```python
+from relayfile import (
+    DIGEST_PATHS,
+    RelayFileClient,
+    is_digest_path,
+    provider_layout_path,
+    resource_schema_path,
+)
+
+client = RelayFileClient("https://api.relayfile.dev", token_provider)
+
+# DIGEST_PATHS is the literal anchor-path taxonomy: the rolling daily
+# files plus rolling and closing-window weekly files. Closed-window daily
+# artifacts use the date-stamped form ``digests/YYYY-MM-DD.md``; filter
+# events through ``is_digest_path`` to subscribe to the full taxonomy
+# (anchor paths plus date-stamped form).
+print(DIGEST_PATHS)
+# (
+#     "digests/yesterday.md",
+#     "digests/today.md",
+#     "digests/this-week.md",
+#     "digests/last-week.md",
+# )
+assert is_digest_path("digests/today.md")
+assert is_digest_path("digests/2026-05-12.md")
+assert is_digest_path("digests/this-week.md")
+assert is_digest_path("digests/last-week.md")
+
+# Read canonical provider layout documentation.
+layout = client.read_file(workspace_id, provider_layout_path("linear"))
+
+# Read a writeback schema served beside a writeback resource.
+schema = client.read_file(
+    workspace_id,
+    resource_schema_path("linear", "issues/AGE-16__abc/comments"),
+)
+
+# Writeback list mirrors `relayfile writeback list --state ...`. Rows come back
+# as typed WritebackItem instances; dead-lettered rows carry an inline
+# DeadLetterErrorPayload resolved from the .error.json sidecar.
+#
+# Naming note: the CLI flag uses `--state dead` (short form); the SDK and wire
+# value is `"dead_lettered"` (the full WritebackState literal). The CLI
+# translates `dead` -> `dead_lettered` before hitting the daemon.
+pending = client.list_writebacks(workspace_id, state="pending")
+# `list_pending_writebacks` is preserved as a thin alias for back-compat.
+
+# Non-pending states (e.g. `"dead_lettered"`, `"succeeded"`, `"failed"`)
+# currently raise NotImplementedError until the state-filtered endpoint
+# (`GET /v1/workspaces/{ws}/writeback?state=...`) is added to the
+# authoritative OpenAPI contract by the `update-relayfile-cli` slice
+# (workspace-primitives work item 5). The typed return shape and the
+# `DeadLetterErrorPayload` coercion are ready ahead of that landing.
+```

relayfile_sdk-0.2.1/README.md

@@ -0,0 +1,71 @@
+# relayfile
+
+Python SDK for the RelayFile virtual filesystem API.
+
+## Install
+
+```bash
+pip install relayfile-sdk
+```
+
+The import namespace remains `relayfile`.
+
+## Workspace Primitives (M1)
+
+The SDK exposes the workspace primitive paths and data shapes used by digest,
+layout, schema, and writeback tooling.
+
+```python
+from relayfile import (
+    DIGEST_PATHS,
+    RelayFileClient,
+    is_digest_path,
+    provider_layout_path,
+    resource_schema_path,
+)
+
+client = RelayFileClient("https://api.relayfile.dev", token_provider)
+
+# DIGEST_PATHS is the literal anchor-path taxonomy: the rolling daily
+# files plus rolling and closing-window weekly files. Closed-window daily
+# artifacts use the date-stamped form ``digests/YYYY-MM-DD.md``; filter
+# events through ``is_digest_path`` to subscribe to the full taxonomy
+# (anchor paths plus date-stamped form).
+print(DIGEST_PATHS)
+# (
+#     "digests/yesterday.md",
+#     "digests/today.md",
+#     "digests/this-week.md",
+#     "digests/last-week.md",
+# )
+assert is_digest_path("digests/today.md")
+assert is_digest_path("digests/2026-05-12.md")
+assert is_digest_path("digests/this-week.md")
+assert is_digest_path("digests/last-week.md")
+
+# Read canonical provider layout documentation.
+layout = client.read_file(workspace_id, provider_layout_path("linear"))
+
+# Read a writeback schema served beside a writeback resource.
+schema = client.read_file(
+    workspace_id,
+    resource_schema_path("linear", "issues/AGE-16__abc/comments"),
+)
+
+# Writeback list mirrors `relayfile writeback list --state ...`. Rows come back
+# as typed WritebackItem instances; dead-lettered rows carry an inline
+# DeadLetterErrorPayload resolved from the .error.json sidecar.
+#
+# Naming note: the CLI flag uses `--state dead` (short form); the SDK and wire
+# value is `"dead_lettered"` (the full WritebackState literal). The CLI
+# translates `dead` -> `dead_lettered` before hitting the daemon.
+pending = client.list_writebacks(workspace_id, state="pending")
+# `list_pending_writebacks` is preserved as a thin alias for back-compat.
+
+# Non-pending states (e.g. `"dead_lettered"`, `"succeeded"`, `"failed"`)
+# currently raise NotImplementedError until the state-filtered endpoint
+# (`GET /v1/workspaces/{ws}/writeback?state=...`) is added to the
+# authoritative OpenAPI contract by the `update-relayfile-cli` slice
+# (workspace-primitives work item 5). The typed return shape and the
+# `DeadLetterErrorPayload` coercion are ready ahead of that landing.
+```

relayfile_sdk-0.2.1/pyproject.toml

@@ -0,0 +1,21 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "relayfile-sdk"
+version = "0.2.1"
+description = "Python SDK for the RelayFile virtual filesystem API"
+readme = "README.md"
+license = "Apache-2.0"
+requires-python = ">=3.10"
+dependencies = ["httpx>=0.27,<1", "websocket-client>=1.7,<2"]
+
+[project.optional-dependencies]
+dev = ["pytest>=8", "pytest-asyncio>=0.24", "respx>=0.22"]
+
+[tool.pytest.ini_options]
+pythonpath = ["src"]
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/relayfile"]

relayfile_sdk-0.2.1/src/relayfile/__init__.py

@@ -0,0 +1,78 @@
+from .client import RelayFileClient, AsyncRelayFileClient, RetryOptions
+from .errors import (
+    RelayFileApiError,
+    RevisionConflictError,
+    QueueFullError,
+    InvalidStateError,
+    PayloadTooLargeError,
+)
+from .provider import (
+    DATE_STAMPED_DIGEST_PATH_PATTERN,
+    DIGEST_PATHS,
+    IntegrationProvider,
+    ListProviderFilesOptions,
+    WatchProviderEventsOptions,
+    WebhookInput,
+    compute_canonical_path,
+    is_digest_path,
+    provider_layout_path,
+    resource_schema_path,
+)
+from .types import (
+    DeadLetterErrorPayload,
+    DigestBullet,
+    DigestContext,
+    DigestHandler,
+    DigestSection,
+    DigestWindow,
+    LayoutManifest,
+    LayoutManifestAlias,
+    LayoutManifestResource,
+    WritebackActionType,
+    WritebackDeadLetterError,
+    WritebackDeadLetterErrorCode,
+    WritebackItem,
+    WritebackItemDetail,
+    WritebackSchemaRef,
+    WritebackState,
+)
+from .on_write import on_write, path_matches
+
+__all__ = [
+    "RelayFileClient",
+    "AsyncRelayFileClient",
+    "RetryOptions",
+    "RelayFileApiError",
+    "RevisionConflictError",
+    "QueueFullError",
+    "InvalidStateError",
+    "PayloadTooLargeError",
+    "IntegrationProvider",
+    "DIGEST_PATHS",
+    "DATE_STAMPED_DIGEST_PATH_PATTERN",
+    "is_digest_path",
+    "WebhookInput",
+    "ListProviderFilesOptions",
+    "WatchProviderEventsOptions",
+    "compute_canonical_path",
+    "provider_layout_path",
+    "resource_schema_path",
+    "DeadLetterErrorPayload",
+    "DigestBullet",
+    "DigestContext",
+    "DigestHandler",
+    "DigestSection",
+    "DigestWindow",
+    "LayoutManifest",
+    "LayoutManifestAlias",
+    "LayoutManifestResource",
+    "WritebackActionType",
+    "WritebackDeadLetterError",
+    "WritebackDeadLetterErrorCode",
+    "WritebackItem",
+    "WritebackItemDetail",
+    "WritebackSchemaRef",
+    "WritebackState",
+    "on_write",
+    "path_matches",
+]