pywire-templates 0.2.0__py3-none-any.whl

pywire_templates/__init__.py

@@ -0,0 +1,29 @@
+"""Shared Jinja2 templates for PyWire deploy + scaffolding."""
+
+from __future__ import annotations
+
+from importlib import resources
+from typing import Any
+
+import jinja2
+
+__version__ = "0.2.0"
+
+
+def _deploy_env() -> jinja2.Environment:
+    return jinja2.Environment(
+        loader=jinja2.PackageLoader("pywire_templates", "deploy"),
+        trim_blocks=True,
+        lstrip_blocks=True,
+        keep_trailing_newline=True,
+    )
+
+
+def render_deploy_template(name: str, **context: Any) -> str:
+    """Render a deploy template by file name (e.g. ``Dockerfile.j2``)."""
+    return _deploy_env().get_template(name).render(**context)
+
+
+def deploy_template_path(name: str) -> str:
+    """Return absolute path to a deploy template file — useful for copies."""
+    return str(resources.files("pywire_templates").joinpath("deploy", name))

pywire_templates/deploy/Dockerfile.j2

@@ -0,0 +1,14 @@
+FROM python:3.12-slim
+WORKDIR /app
+
+COPY --from=ghcr.io/astral-sh/uv:latest /uv /bin/uv
+COPY pyproject.toml uv.lock ./
+RUN uv sync --frozen --no-dev
+
+COPY . .
+
+# Session timeout in seconds (default: 1800 = 30 min)
+ENV SESSION_TTL=1800
+
+EXPOSE 8000
+CMD ["uv", "run", "pywire", "run", "--host", "0.0.0.0", "--port", "8000", "--workers", "{{ workers }}"]

pywire_templates/deploy/entry.py.j2

@@ -0,0 +1,35 @@
+import asgi
+from {{ app_module }} import {{ app_attr }}
+import _routes  # noqa: F401 — registers routes as a side effect
+from pywire_do import PyWireSessionDO
+from workers import WorkerEntrypoint, Response
+from js import URL, Request as JsRequest
+import uuid
+
+
+class Default(WorkerEntrypoint):
+    async def on_fetch(self, request):
+        url = URL.new(request.url)
+        upgrade = (request.headers.get("Upgrade") or "").lower()
+
+        if upgrade == "websocket":
+            session_id = url.searchParams.get("session") or str(uuid.uuid4())
+            stub = self.env.PYWIRE_SESSION.getByName(session_id)
+            return await stub.fetch(request)
+
+        # Pre-warm a Durable Object so it's ready when the client opens a WS.
+        # The DO cold start overlaps with the browser loading HTML + JS.
+        session_id = str(uuid.uuid4())
+        stub = self.env.PYWIRE_SESSION.getByName(session_id)
+        self.ctx.waitUntil(stub.fetch(JsRequest.new("http://do/warm")))
+
+        # Serve the page via ASGI
+        response = await asgi.fetch({{ app_attr }}, request.js_object, self.env)
+
+        # Inject pre-assigned session into the HTML so the client
+        # connects to the already-warming DO instead of creating a new one.
+        body = await response.text()
+        meta = '<meta name="pywire-session" content="' + session_id + '">'
+        body = body.replace("</head>", meta + "</head>", 1)
+
+        return Response.new(body, status=response.status, headers=response.headers)

pywire_templates/deploy/fly.toml.j2

@@ -0,0 +1,19 @@
+app = "{{ project_name }}"
+primary_region = "ord"
+
+[build]
+  dockerfile = "Dockerfile"
+
+[http_service]
+  internal_port = 8000
+  force_https = true
+  auto_stop_machines = "stop"
+  auto_start_machines = true
+
+[env]
+  # Session timeout in seconds (default: 1800 = 30 min)
+  SESSION_TTL = "1800"
+
+[[vm]]
+  memory = "512mb"
+  cpus = 1

pywire_templates/deploy/pywire_do.py.j2

@@ -0,0 +1,180 @@
+"""PyWire Durable Object — session actor with WebSocket hibernation.
+
+This module is generated by `pywire build --platform cloudflare`.
+Uses shared pywire.runtime modules for protocol + page resolution.
+
+All imports are at the top level so they are captured in the Cloudflare
+Workers memory snapshot at deploy time, giving fast cold starts.
+"""
+
+from workers import DurableObject, Response
+from js import WebSocketPair
+from pyodide.ffi import to_js
+from {{ app_module }} import {{ app_attr }}
+import _routes  # noqa: F401 — registers routes as a side effect
+import msgpack
+from pywire.runtime.session_serializer import snapshot_page_state, restore_page_state
+from pywire.runtime.protocol import build_update_payload
+from pywire.runtime.page_resolver import resolve_page
+
+
+def _send(ws, msg):
+    ws.send(to_js(msgpack.packb(msg)))
+
+
+def _send_update(ws, update):
+    _send(ws, build_update_payload(update))
+
+
+def _decode(message):
+    try:
+        if isinstance(message, (bytes, bytearray, memoryview)):
+            return msgpack.unpackb(message, raw=False)
+        if hasattr(message, "to_py"):
+            return msgpack.unpackb(bytes(message.to_py()), raw=False)
+        return {}
+    except Exception:
+        return {}
+
+
+def _resolve_page(path):
+    result = resolve_page({{ app_attr }}.router, path)
+    if result is None:
+        return None
+    page, _params, _variant_name = result
+    return page
+
+
+class PyWireSessionDO(DurableObject):
+    def __init__(self, state, env):
+        super().__init__(state, env)
+        self.ctx = state
+        self.page = None
+
+    async def on_fetch(self, request):
+        upgrade = (request.headers.get("Upgrade") or "").lower()
+        if upgrade == "websocket":
+            pair = WebSocketPair.new()
+            client, server = pair.object_values()
+            self.ctx.acceptWebSocket(server)
+            return Response(None, status=101, web_socket=client)
+        return Response("OK", headers={"Content-Type": "text/plain"})
+
+    async def on_webSocketMessage(self, ws, message):
+        msg = _decode(message)
+        msg_type = msg.get("type", "")
+        try:
+            if msg_type == "init":
+                await self._handle_init(ws, msg)
+            elif msg_type == "event":
+                await self._handle_event(ws, msg)
+            elif msg_type == "relocate":
+                await self._handle_relocate(ws, msg)
+            elif msg_type == "pong":
+                pass
+        except Exception as e:
+            import traceback
+            traceback.print_exc()
+            _send(ws, {"type": "error", "error": str(e)})
+
+    async def on_webSocketClose(self, ws, code, reason, was_clean):
+        if self.page:
+            await self._persist_state()
+        ws.close(code, reason)
+
+    async def _restore_from_storage(self, page):
+        snapshot = await self.ctx.storage.get("page_state")
+        if snapshot:
+            try:
+                state = snapshot.to_py() if hasattr(snapshot, "to_py") else snapshot
+                restore_page_state(page, state)
+                return True
+            except Exception:
+                pass
+        return False
+
+    def _setup_broadcaster(self, ws, page):
+        async def broadcast_update():
+            update = await page.render_update(init=False)
+            _send_update(ws, update)
+        page._on_update = broadcast_update
+
+    async def _handle_init(self, ws, msg):
+        path = msg.get("path", "/")
+        self.page = _resolve_page(path)
+        if not self.page:
+            _send(ws, {"type": "error", "error": "Not Found"})
+            return
+
+        session_restored = await self._restore_from_storage(self.page)
+        self._setup_broadcaster(ws, self.page)
+        await self.page.render(init=True)
+
+        if self.page._pending_navigation:
+            _send(ws, {"type": "navigate", "path": self.page._pending_navigation})
+            self.page._pending_navigation = None
+            return
+
+        _send(ws, {
+            "type": "init_ack",
+            "session_id": "",
+            "session_restored": session_restored,
+        })
+        await self.page._run_hooks(self.page.MOUNT_HOOKS)
+        await self._persist_state()
+
+    async def _handle_event(self, ws, msg):
+        handler_name = msg.get("handler")
+        event_data = msg.get("data", {})
+
+        if not self.page:
+            self.page = _resolve_page(msg.get("path", "/"))
+            if not self.page:
+                _send(ws, {"type": "error", "error": "No page"})
+                return
+            await self._restore_from_storage(self.page)
+            await self.page.render(init=True)
+
+        self._setup_broadcaster(ws, self.page)
+
+        if handler_name:
+            update = await self.page.handle_event(handler_name, event_data)
+        else:
+            update = await self.page.render_update(init=False)
+
+        if self.page._pending_navigation:
+            _send(ws, {"type": "navigate", "path": self.page._pending_navigation})
+            self.page._pending_navigation = None
+            return
+
+        _send_update(ws, update)
+        await self.page._run_hooks(self.page.AFTER_UPDATE_HOOKS)
+        await self._persist_state()
+
+    async def _handle_relocate(self, ws, msg):
+        path = msg.get("path", "/")
+        old_page = self.page
+
+        self.page = _resolve_page(path)
+        if not self.page:
+            _send(ws, {"type": "reload"})
+            return
+
+        if old_page:
+            self.page.user = getattr(old_page, "user", None)
+
+        self._setup_broadcaster(ws, self.page)
+        response = await self.page.render(init=False)
+        html = response.body.decode("utf-8") if isinstance(response.body, bytes) else response.body
+        _send(ws, {"type": "update", "html": html})
+        await self.page._run_hooks(self.page.MOUNT_HOOKS)
+        await self._persist_state()
+
+    async def _persist_state(self):
+        if not self.page:
+            return
+        try:
+            snapshot = snapshot_page_state(self.page)
+            await self.ctx.storage.put("page_state", to_js(snapshot))
+        except Exception:
+            pass

pywire_templates/deploy/railway.json.j2

@@ -0,0 +1,6 @@
+{
+  "$schema": "https://railway.com/railway.schema.json",
+  "build": {
+    "dockerfilePath": "Dockerfile"
+  }
+}

pywire_templates/deploy/render.yaml.j2

@@ -0,0 +1,25 @@
+services:
+  - type: web
+    name: {{ project_name }}
+    runtime: docker
+{% if redis_enabled %}
+    plan: starter
+    envVars:
+      - key: REDIS_URL
+        fromService:
+          name: {{ project_name }}-kv
+          type: keyvalue
+          property: connectionString
+      - key: SESSION_TTL
+        value: "1800"  # Session timeout in seconds (default: 30 min)
+
+  - type: keyvalue
+    name: {{ project_name }}-kv
+    plan: starter
+    ipAllowList: []
+{% else %}
+    plan: free
+    envVars:
+      - key: SESSION_TTL
+        value: "1800"  # Session timeout in seconds (default: 30 min)
+{% endif %}

pywire_templates/deploy/wrangler.toml.j2

@@ -0,0 +1,18 @@
+name = "{{ project_name }}"
+main = "entry.py"
+compatibility_date = "2025-01-01"
+compatibility_flags = ["python_workers"]
+workers_dev = false
+preview_urls = false
+
+[assets]
+directory = "./.pywire/deploy/public"
+binding = "ASSETS"
+
+[[durable_objects.bindings]]
+name = "PYWIRE_SESSION"
+class_name = "PyWireSessionDO"
+
+[[migrations]]
+tag = "v1"
+new_sqlite_classes = ["PyWireSessionDO"]

pywire_templates-0.2.0.dist-info/METADATA

@@ -0,0 +1,46 @@
+Metadata-Version: 2.4
+Name: pywire-templates
+Version: 0.2.0
+Summary: Shared Jinja2 templates for PyWire deployment and scaffolding
+Project-URL: Homepage, https://pywire.dev
+Project-URL: Repository, https://github.com/pywire/pywire
+Author-email: Reece Holmdahl <reece@pywire.dev>
+License-Expression: MIT
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Topic :: Software Development :: Code Generators
+Requires-Python: >=3.11
+Requires-Dist: jinja2>=3.1.0
+Description-Content-Type: text/markdown
+
+# pywire-templates
+
+Shared Jinja2 templates consumed by `pywire-cli` (for `pywire deploy`) and `create-pywire-app` (for project scaffolding).
+
+End users should not depend on this package directly. It exists so deployment configs (Dockerfile, fly.toml, render.yaml, wrangler.toml, railway.json, Cloudflare entry/DO) live in one place.
+
+## Layout
+
+```
+src/pywire_templates/
+  deploy/          # deployment config templates
+    Dockerfile.j2
+    fly.toml.j2
+    render.yaml.j2
+    wrangler.toml.j2
+    railway.json.j2
+    entry.py.j2
+    pywire_do.py.j2
+```
+
+## Usage
+
+```python
+from pywire_templates import render_deploy_template
+
+content = render_deploy_template("Dockerfile.j2", workers=4)
+```

pywire_templates-0.2.0.dist-info/RECORD

@@ -0,0 +1,11 @@
+pywire_templates/__init__.py,sha256=ceclc3g9hgCRfwyh7smPC7sk3TtAWIvrMaNqMFumLng,833
+pywire_templates/deploy/Dockerfile.j2,sha256=KUVcV0_p9Dxdw6CaFKQmE5CsZXlhgixDRNvxQalwOlE,352
+pywire_templates/deploy/entry.py.j2,sha256=1UlTdjheYJ6PKn1tDQJaFk4StYW6hsgMGKUPE0hxKRU,1499
+pywire_templates/deploy/fly.toml.j2,sha256=k8rh159RpI1bc_1mCNcro4FLUyRtrEh2KwyNVkSumyk,330
+pywire_templates/deploy/pywire_do.py.j2,sha256=KcrOMRok_-XA9IZHOFMr8T2DJyiCdfrObRL-Q2WENpc,6108
+pywire_templates/deploy/railway.json.j2,sha256=l5eYYAkAvk7VmT-DNVybj8J82ws1Tw_zb6ESaTI9G-U,112
+pywire_templates/deploy/render.yaml.j2,sha256=mIqoc2j0TJPCAEdUgs2oxuih_8C0s9usss-VdO46svk,602
+pywire_templates/deploy/wrangler.toml.j2,sha256=hNv6H89fi1tVxiwILCoLC3PusWtLvqzxmXvITm9wuTs,382
+pywire_templates-0.2.0.dist-info/METADATA,sha256=2UDhoncqcis5VyLmt_jbMFsY-Z1ZqnrnjsS98suyCvM,1441
+pywire_templates-0.2.0.dist-info/WHEEL,sha256=QccIxa26bgl1E6uMy58deGWi-0aeIkkangHcxk2kWfw,87
+pywire_templates-0.2.0.dist-info/RECORD,,

pywire_templates-0.2.0.dist-info/WHEEL

@@ -0,0 +1,4 @@
+Wheel-Version: 1.0
+Generator: hatchling 1.29.0
+Root-Is-Purelib: true
+Tag: py3-none-any