livepeer-frameworks 0.1.0__tar.gz

livepeer_frameworks-0.1.0/.gitignore

@@ -0,0 +1,189 @@
+# Private runbook (environment-specific, do not commit)
+/PRIVATE_RUNBOOK.md
+/PLAN_*
+/REPORT_*
+
+# Operating System
+.DS_Store
+Thumbs.db
+Desktop.ini
+*~
+.Trash*
+.cache
+.directory
+ansible/.ansible/
+
+# IDE & Editor
+.vscode/*
+!.vscode/settings.json
+!.vscode/tasks.json
+!.vscode/launch.json
+!.vscode/extensions.json
+.idea/
+*.swp
+*.swo
+*.sublime-*
+*~
+\#*\#
+
+# Node.js & Frontend
+node_modules/
+.pnpm-store/
+dist/
+build/
+.svelte-kit/
+.next/
+.nuxt/
+.output/
+.vite/
+website_marketing/.react-router/
+coverage/
+test-results/
+*.log
+.env*
+!.env.example
+
+# Claude Code per-project local state
+.claude/
+.playwright-cli/
+
+# Houdini (GraphQL client)
+$houdini/
+.houdini/
+
+# Go
+*.exe
+*.dll
+*.so
+*.dylib
+*.test
+*.out
+go.work*
+vendor/
+
+# Android
+.gradle/
+build/
+local.properties
+.externalNativeBuild/
+.cxx/
+*.hprof
+*.jks
+*.keystore
+
+# Infrastructure
+*.db
+*.sqlite*
+*.dump
+docker-compose.override.yml
+.terraform*
+*.tfstate*
+
+# Temporary & Logs
+**/tmp/
+**/EXAMPLE*/
+!npm_api/examples/
+!npm_api/examples/**
+!sdk_go/examples/
+!sdk_go/examples/**
+!sdk_python/examples/
+!sdk_python/examples/**
+**/temp/
+**/logs/
+*.log
+*.pid
+*.seed
+bin
+
+# Compiled Go binaries inside cmd/ directories
+**/cmd/*/*
+!**/cmd/*/*.go
+!**/cmd/*/
+
+# Go binaries from manual `go build` in service directories
+api_balancing/foghorn
+api_billing/purser
+api_consultant/skipper
+api_control/commodore
+api_dns/navigator
+api_firehose/decklog
+api_forms/steward
+api_gateway/bridge
+api_analytics_ingest/periscope
+api_analytics_query/periscope
+api_mesh/privateer
+api_realtime/signalman
+api_sidecar/helmsman
+api_tenants/quartermaster
+api_ticketing/deckhand
+api_assets/chandler
+scripts/registry/registry
+tools/release-plan/release-plan
+
+# Security & Sensitive
+*.pem
+*.key
+*.crt
+*.cert
+secrets.*
+config/env/secrets.env
+!config/env/secrets.env.example
+scripts/env/.gocache/
+scripts/env/env
+**/.gocache/
+
+
+# Backups & Archives
+*.bak
+*.backup
+*.orig
+*.zip
+*.tar*
+*.rar
+*.7z
+
+# Project Specific
+mistserver.conf.bak
+infrastructure/nginx/logs/
+
+# Generated by local Mist/Helmsman demo runs. Tracked seed fixtures under this
+# tree remain tracked; these rules keep fresh runtime outputs out of status.
+infrastructure/demo-recordings/processing/
+infrastructure/demo-recordings/trigger-wal/
+infrastructure/demo-recordings/**/*.blocks/
+infrastructure/demo-recordings/**/*.dtsh
+infrastructure/demo-recordings/**/*.m3u8
+infrastructure/demo-recordings/**/*.mkv
+infrastructure/demo-recordings/**/*.ts
+infrastructure/demo-recordings/**/*.pb
+
+# Dead code analysis reports
+reports/
+
+# Agent discovery files (copied from docs/skills/ by prebuild)
+website_application/static/SKILL.md
+website_application/static/skill.json
+website_application/static/heartbeat.md
+website_application/static/llms.txt
+website_application/static/robots.txt
+website_application/static/.well-known/
+website_marketing/public/SKILL.md
+website_marketing/public/skill.json
+website_marketing/public/heartbeat.md
+website_marketing/public/llms.txt
+website_marketing/public/robots.txt
+website_marketing/public/.well-known/
+website_docs/public/SKILL.md
+website_docs/public/skill.json
+website_docs/public/heartbeat.md
+website_docs/public/llms.txt
+website_docs/public/robots.txt
+website_docs/public/.well-known/
+.two-cell-pull-upstream/
+
+# Python SDK dev environment and caches
+sdk_python/.venv/
+__pycache__/
+.mypy_cache/
+.pytest_cache/
+*.egg-info/

livepeer_frameworks-0.1.0/PKG-INFO

@@ -0,0 +1,75 @@
+Metadata-Version: 2.5
+Name: livepeer-frameworks
+Version: 0.1.0
+Summary: Typed client for the FrameWorks GraphQL API: operations, retries, pagination, typed errors, uploads, playback tokens, and webhooks
+Project-URL: Documentation, https://logbook.frameworks.network/builders/sdks
+Project-URL: Source, https://github.com/Livepeer-FrameWorks/monorepo/tree/master/sdk_python
+Author: Livepeer FrameWorks
+License-Expression: Unlicense
+Keywords: frameworks,graphql,livepeer,sdk,streaming
+Classifier: Framework :: AsyncIO
+Classifier: Programming Language :: Python :: 3
+Classifier: Typing :: Typed
+Requires-Python: >=3.10
+Requires-Dist: betterproto2==0.10.0
+Requires-Dist: cryptography>=43
+Requires-Dist: graphql-core<3.3,>=3.2
+Requires-Dist: httpx<1,>=0.27
+Requires-Dist: pydantic<3,>=2.7
+Requires-Dist: standardwebhooks<2,>=1.1.0
+Requires-Dist: websockets<18,>=13
+Provides-Extra: dev
+Requires-Dist: ariadne-codegen==0.19.0; extra == 'dev'
+Requires-Dist: betterproto2-compiler==0.10.1; extra == 'dev'
+Requires-Dist: build==1.6.1; extra == 'dev'
+Requires-Dist: mypy==2.3.1; extra == 'dev'
+Requires-Dist: pytest-asyncio==1.4.0; extra == 'dev'
+Requires-Dist: pytest==9.1.1; extra == 'dev'
+Requires-Dist: ruff==0.15.22; extra == 'dev'
+Requires-Dist: twine==7.0.0; extra == 'dev'
+Description-Content-Type: text/markdown
+
+# livepeer-frameworks
+
+Typed Python client for the [FrameWorks](https://frameworks.network) GraphQL API. It ships a sync
+and an async client generated from FrameWorks' curated public operations, with pydantic models,
+retries, pagination, typed errors, a VOD upload helper, playback token signing, and webhook
+verification.
+
+```sh
+pip install livepeer-frameworks
+```
+
+```python
+from livepeer_frameworks import FrameWorksClient, expect_result, paginate_relay
+from livepeer_frameworks.graphql import ConnectionInput, CreateStreamCreateStreamStream, CreateStreamInput
+
+with FrameWorksClient("https://bridge.example.com/graphql", token="YOUR_API_TOKEN") as fw:
+    created = fw.create_stream(input=CreateStreamInput(name="Studio A"))
+    # Returns the Stream member or raises ResultError for ValidationError/AuthError.
+    stream = expect_result(created.create_stream, CreateStreamCreateStreamStream)
+    print(stream.stream_key, stream.playback_id)
+
+    for s in paginate_relay(
+        lambda page: fw.list_streams(page=ConnectionInput.model_validate(page)).streams_connection
+    ):
+        print(s.name)
+```
+
+The client reads no environment variables; pass the URL and token explicitly. Per-call options are
+keyword arguments of the generated methods: `idempotency_key=` (sent as `Idempotency-Key`; paid
+mutations settled with x402 need one) and `playback_token=` (sent as `X-Frameworks-Playback-JWT`).
+
+Queries are retried on network errors and HTTP 408, 429, and 5xx. A mutation is retried only when
+the request provably never reached the server: the connection could not be established, or the
+gateway answered 429. It is never sent again after a timeout, a dropped connection, or a 5xx,
+because the gateway does not deduplicate replayed mutations.
+
+## Versions
+
+The TypeScript, Go, and Python SDKs share one version. Until FrameWorks 1.0 the SDKs stay at 0.x,
+and each minor line supports the FrameWorks releases listed for it; this line needs FrameWorks
+v0.3.11 or later. Against an older stable release the client raises `ServerTooOldError` before
+sending a call.
+
+Documentation: <https://logbook.frameworks.network/builders/sdks>

livepeer_frameworks-0.1.0/README.md

@@ -0,0 +1,44 @@
+# livepeer-frameworks
+
+Typed Python client for the [FrameWorks](https://frameworks.network) GraphQL API. It ships a sync
+and an async client generated from FrameWorks' curated public operations, with pydantic models,
+retries, pagination, typed errors, a VOD upload helper, playback token signing, and webhook
+verification.
+
+```sh
+pip install livepeer-frameworks
+```
+
+```python
+from livepeer_frameworks import FrameWorksClient, expect_result, paginate_relay
+from livepeer_frameworks.graphql import ConnectionInput, CreateStreamCreateStreamStream, CreateStreamInput
+
+with FrameWorksClient("https://bridge.example.com/graphql", token="YOUR_API_TOKEN") as fw:
+    created = fw.create_stream(input=CreateStreamInput(name="Studio A"))
+    # Returns the Stream member or raises ResultError for ValidationError/AuthError.
+    stream = expect_result(created.create_stream, CreateStreamCreateStreamStream)
+    print(stream.stream_key, stream.playback_id)
+
+    for s in paginate_relay(
+        lambda page: fw.list_streams(page=ConnectionInput.model_validate(page)).streams_connection
+    ):
+        print(s.name)
+```
+
+The client reads no environment variables; pass the URL and token explicitly. Per-call options are
+keyword arguments of the generated methods: `idempotency_key=` (sent as `Idempotency-Key`; paid
+mutations settled with x402 need one) and `playback_token=` (sent as `X-Frameworks-Playback-JWT`).
+
+Queries are retried on network errors and HTTP 408, 429, and 5xx. A mutation is retried only when
+the request provably never reached the server: the connection could not be established, or the
+gateway answered 429. It is never sent again after a timeout, a dropped connection, or a 5xx,
+because the gateway does not deduplicate replayed mutations.
+
+## Versions
+
+The TypeScript, Go, and Python SDKs share one version. Until FrameWorks 1.0 the SDKs stay at 0.x,
+and each minor line supports the FrameWorks releases listed for it; this line needs FrameWorks
+v0.3.11 or later. Against an older stable release the client raises `ServerTooOldError` before
+sending a call.
+
+Documentation: <https://logbook.frameworks.network/builders/sdks>

livepeer_frameworks-0.1.0/pyproject.toml

@@ -0,0 +1,88 @@
+[build-system]
+requires = ["hatchling>=1.27"]
+build-backend = "hatchling.build"
+
+[project]
+name = "livepeer-frameworks"
+dynamic = ["version"]
+description = "Typed client for the FrameWorks GraphQL API: operations, retries, pagination, typed errors, uploads, playback tokens, and webhooks"
+readme = "README.md"
+requires-python = ">=3.10"
+license = "Unlicense"
+authors = [{ name = "Livepeer FrameWorks" }]
+keywords = ["frameworks", "livepeer", "graphql", "streaming", "sdk"]
+classifiers = [
+  "Programming Language :: Python :: 3",
+  "Typing :: Typed",
+  "Framework :: AsyncIO",
+]
+dependencies = [
+  "graphql-core>=3.2,<3.3",
+  "httpx>=0.27,<1",
+  "pydantic>=2.7,<3",
+  "websockets>=13,<18",
+  "standardwebhooks>=1.1.0,<2",
+  "betterproto2==0.10.0",
+  "cryptography>=43",
+]
+
+[project.optional-dependencies]
+dev = [
+  "ariadne-codegen==0.19.0",
+  "betterproto2-compiler==0.10.1",
+  # Both generators format their output with ruff; pinned so the generated
+  # tree is byte-identical on every machine.
+  "ruff==0.15.22",
+  "mypy==2.3.1",
+  "pytest==9.1.1",
+  "pytest-asyncio==1.4.0",
+  # scripts/publish-packages.sh builds the distributions and uploads them.
+  "build==1.6.1",
+  "twine==7.0.0",
+]
+
+[project.urls]
+Documentation = "https://logbook.frameworks.network/builders/sdks"
+Source = "https://github.com/Livepeer-FrameWorks/monorepo/tree/master/sdk_python"
+
+# The version is the shared SDK version, emitted from npm_api/package.json by
+# scripts/sdkcontract (make graphql-sdk-py).
+[tool.hatch.version]
+path = "src/livepeer_frameworks/_generated/manifest.py"
+pattern = 'SDK_VERSION: Final = "(?P<version>[^"]+)"'
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/livepeer_frameworks"]
+
+[tool.hatch.build.targets.sdist]
+include = ["src/livepeer_frameworks", "README.md", "pyproject.toml"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+asyncio_mode = "auto"
+asyncio_default_fixture_loop_scope = "function"
+
+[tool.mypy]
+python_version = "3.10"
+strict = true
+mypy_path = "src"
+packages = ["livepeer_frameworks"]
+plugins = ["pydantic.mypy"]
+
+# The GraphQL client and models are checked with the defaults; they are
+# fully annotated but ariadne-codegen emits patterns strict mode rejects.
+[[tool.mypy.overrides]]
+module = ["livepeer_frameworks._generated.graphql.*"]
+disallow_any_generics = false
+warn_return_any = false
+disallow_untyped_calls = false
+
+# betterproto2 output is third-party generated code (google.protobuf and the
+# event messages); the SDK checks its use of it, not its internals.
+[[tool.mypy.overrides]]
+module = ["livepeer_frameworks._generated.proto.*"]
+ignore_errors = true
+
+[[tool.mypy.overrides]]
+module = ["standardwebhooks.*"]
+ignore_missing_imports = true

livepeer_frameworks-0.1.0/src/livepeer_frameworks/__init__.py

@@ -0,0 +1,81 @@
+"""Typed client for the FrameWorks GraphQL API."""
+
+from ._forward import OpenEnum, UnknownMember
+from ._generated.manifest import MIN_SERVER_VERSION, OPERATIONS, SDK_LINE, SDK_VERSION
+from ._server_info import ServerStatus
+from .client import AsyncFrameWorksClient, FrameWorksClient
+from .errors import (
+    AuthenticationError,
+    FrameWorksError,
+    GraphQLError,
+    HTTPError,
+    NetworkError,
+    PaymentRequiredError,
+    ProtocolError,
+    RateLimitError,
+    ResultError,
+    SchemaMismatchError,
+    ServerError,
+    ServerTooOldError,
+    UnsupportedOperationError,
+    UploadError,
+    WebhookVerificationError,
+)
+from .pagination import (
+    apaginate_offset,
+    apaginate_page_token,
+    apaginate_relay,
+    paginate_offset,
+    paginate_page_token,
+    paginate_relay,
+)
+from .playback_token import sign_playback_token
+from .results import expect_result
+from .retry import DEFAULT_RETRY_POLICY, RetryPolicy
+from .upload import async_upload_vod, upload_vod
+from .webhooks import WebhookEvent, WebhookReceiver, parse_webhook_event
+
+__version__ = SDK_VERSION
+
+__all__ = [
+    "AsyncFrameWorksClient",
+    "AuthenticationError",
+    "DEFAULT_RETRY_POLICY",
+    "FrameWorksClient",
+    "FrameWorksError",
+    "GraphQLError",
+    "HTTPError",
+    "MIN_SERVER_VERSION",
+    "NetworkError",
+    "OPERATIONS",
+    "OpenEnum",
+    "PaymentRequiredError",
+    "ProtocolError",
+    "RateLimitError",
+    "ResultError",
+    "RetryPolicy",
+    "SDK_LINE",
+    "SDK_VERSION",
+    "SchemaMismatchError",
+    "ServerError",
+    "ServerStatus",
+    "ServerTooOldError",
+    "UnknownMember",
+    "UnsupportedOperationError",
+    "UploadError",
+    "WebhookEvent",
+    "WebhookReceiver",
+    "WebhookVerificationError",
+    "__version__",
+    "apaginate_offset",
+    "apaginate_page_token",
+    "apaginate_relay",
+    "async_upload_vod",
+    "expect_result",
+    "paginate_offset",
+    "paginate_page_token",
+    "paginate_relay",
+    "parse_webhook_event",
+    "sign_playback_token",
+    "upload_vod",
+]

livepeer_frameworks-0.1.0/src/livepeer_frameworks/_forward.py

@@ -0,0 +1,97 @@
+"""Decoding of result union members and enum values a newer server adds.
+
+The SDK supports a range of server releases, and a later release may add a
+member to a union or a value to an enum. The generated models use the types
+below (codegen/forward_compat.py rewrites them), so such a response decodes
+instead of failing validation."""
+
+from __future__ import annotations
+
+from enum import Enum
+from typing import Any, get_args
+
+from pydantic import BaseModel, ConfigDict, GetCoreSchemaHandler, model_serializer
+from pydantic_core import core_schema
+
+# The tag the discriminator returns for a __typename no member declares. It
+# cannot collide with a GraphQL type name.
+_UNKNOWN_TAG = "<unknown>"
+
+
+class UnknownMember(BaseModel):
+    """A union member this SDK does not know: a type a newer server added.
+
+    typename__ is its __typename and raw its JSON exactly as the server sent
+    it; dumping the member returns raw. expect_result raises it as a
+    ResultError carrying its __typename, message, and code."""
+
+    model_config = ConfigDict(frozen=True)
+
+    typename__: str
+    raw: dict[str, Any]
+
+    @model_serializer
+    def _dump_raw(self) -> dict[str, Any]:
+        return self.raw
+
+
+class OpenUnion:
+    """Annotated metadata for a generated union field: members are chosen by
+    __typename, and a __typename no member declares becomes an UnknownMember.
+
+    The annotated type is Union[<generated members>, UnknownMember]; each
+    generated member declares its __typename as typename__: Literal[...]."""
+
+    def __get_pydantic_core_schema__(self, source: Any, handler: GetCoreSchemaHandler) -> core_schema.CoreSchema:
+        choices: dict[str, core_schema.CoreSchema] = {}
+        for member in get_args(source):
+            if member is UnknownMember:
+                continue
+            field = member.model_fields.get("typename__") if isinstance(member, type) and issubclass(member, BaseModel) else None
+            tags = get_args(field.annotation) if field is not None else ()
+            if not tags:
+                raise TypeError(f"union member {member!r} does not declare typename__ as a Literal")
+            for typename in tags:
+                choices[typename] = handler.generate_schema(member)
+        choices[_UNKNOWN_TAG] = core_schema.no_info_before_validator_function(
+            _unknown_member_input, handler.generate_schema(UnknownMember)
+        )
+        known = frozenset(choices) - {_UNKNOWN_TAG}
+
+        def tag(value: Any) -> str | None:
+            if isinstance(value, UnknownMember):
+                return _UNKNOWN_TAG
+            typename = value.get("__typename") if isinstance(value, dict) else getattr(value, "typename__", None)
+            if not isinstance(typename, str):
+                return None
+            return typename if typename in known else _UNKNOWN_TAG
+
+        return core_schema.tagged_union_schema(choices, tag)
+
+
+def _unknown_member_input(value: Any) -> Any:
+    if isinstance(value, dict):
+        return {"typename__": value["__typename"], "raw": dict(value)}
+    return value
+
+
+class OpenEnum(str, Enum):
+    """Base of the generated enums. A value this SDK does not know, which a
+    newer server added, decodes to a member of the enum whose value and name
+    are the server's string and whose is_unknown is True; it is not one of
+    the enum's declared members, so an exhaustive match falls through to its
+    default case."""
+
+    @classmethod
+    def _missing_(cls, value: object) -> Any:
+        if not isinstance(value, str):
+            return None
+        member = str.__new__(cls, value)
+        member._name_ = value
+        member._value_ = value
+        return member
+
+    @property
+    def is_unknown(self) -> bool:
+        """Whether the value is one this SDK does not know."""
+        return self._value_ not in type(self)._value2member_map_

livepeer_frameworks-0.1.0/src/livepeer_frameworks/_generated/__init__.py

@@ -0,0 +1,3 @@
+"""Code generated by make graphql-sdk-py: the operation manifest, the event
+registry, the GraphQL clients and models (graphql/), and the public event
+payload types (proto/)."""

livepeer_frameworks-0.1.0/src/livepeer_frameworks/_generated/events.py

@@ -0,0 +1,67 @@
+# Code generated by scripts/sdkcontract from pkg/graphql/public and the event registry. DO NOT EDIT.
+
+from typing import Final
+
+import betterproto2
+
+from .proto.frameworks.events.public.v1 import (
+    AccountSuspended,
+    ApiTokenCreated,
+    ApiTokenRevoked,
+    BillingDetailsUpdated,
+    ClipFailed,
+    ClipReady,
+    ClipRequested,
+    CustomDomainFailed,
+    CustomDomainVerified,
+    InvoiceCreated,
+    InvoicePaid,
+    MultistreamStatusChanged,
+    PaymentFailed,
+    RecordingFailed,
+    RecordingReady,
+    StreamConnected,
+    StreamCreated,
+    StreamDeleted,
+    StreamIdle,
+    StreamKeyRotated,
+    StreamLive,
+    StreamUpdated,
+    TopupCredited,
+    UploadAborted,
+    UploadCompleted,
+    UploadCreated,
+    UploadFailed,
+    UploadReady,
+)
+
+PUBLIC_EVENT_MESSAGES: Final[dict[str, type[betterproto2.Message]]] = {
+    "account.suspended": AccountSuspended,
+    "api_token.created": ApiTokenCreated,
+    "api_token.revoked": ApiTokenRevoked,
+    "billing.details_updated": BillingDetailsUpdated,
+    "billing.invoice_created": InvoiceCreated,
+    "billing.invoice_paid": InvoicePaid,
+    "billing.payment_failed": PaymentFailed,
+    "billing.topup_credited": TopupCredited,
+    "clip.failed": ClipFailed,
+    "clip.ready": ClipReady,
+    "clip.requested": ClipRequested,
+    "custom_domain.failed": CustomDomainFailed,
+    "custom_domain.verified": CustomDomainVerified,
+    "multistream.status_changed": MultistreamStatusChanged,
+    "recording.failed": RecordingFailed,
+    "recording.ready": RecordingReady,
+    "stream.connected": StreamConnected,
+    "stream.created": StreamCreated,
+    "stream.deleted": StreamDeleted,
+    "stream.idle": StreamIdle,
+    "stream.key_rotated": StreamKeyRotated,
+    "stream.live": StreamLive,
+    "stream.updated": StreamUpdated,
+    "upload.aborted": UploadAborted,
+    "upload.completed": UploadCompleted,
+    "upload.created": UploadCreated,
+    "upload.failed": UploadFailed,
+    "upload.ready": UploadReady,
+}