pyjs-examples 0.0.2__tar.gz → 0.3.0__tar.gz

{pyjs_examples-0.0.2 → pyjs_examples-0.3.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: pyjs-examples
-Version: 0.0.2
+Version: 0.3.0
 Summary: Official example applications for PyJS.
 Author-email: Lex Berezhny <lex@damoti.com>
 License-Expression: BSD-3-Clause
@@ -18,15 +18,20 @@ Classifier: Topic :: Internet :: WWW/HTTP
 Classifier: Topic :: Software Development :: Libraries :: Python Modules
 Requires-Python: >=3.14
 Description-Content-Type: text/markdown
-Requires-Dist: pyjs==0.0.2
+Requires-Dist: pyjs==0.3.0
+Provides-Extra: issue-tracker
+Requires-Dist: django<6.2,>=6.0; extra == "issue-tracker"
+Requires-Dist: pydantic<3,>=2; extra == "issue-tracker"
+Requires-Dist: uvicorn<1,>=0.52; extra == "issue-tracker"
 Provides-Extra: test
 Requires-Dist: pytest>=9.0; extra == "test"
 
 # PyJS Examples
 
-This directory is the source tree for the separately installable `pyjs-examples` distribution.
-Setuptools maps this directory to the `pyjs_examples` import package, so the examples remain easy to
-browse in the repository while installing as an ordinary top-level package.
+This directory is the source tree for the separately installable
+`pyjs-examples` distribution. Setuptools maps this directory to the
+`pyjs_examples` import package, so the examples remain easy to browse in the
+repository while installing as an ordinary top-level package.
 
 From the repository root, install the core and examples from a source checkout:
 
@@ -34,7 +39,8 @@ From the repository root, install the core and examples from a source checkout:
 uv sync
 ```
 
-An installed PyJS release provides the same package through the `examples` extra:
+An installed PyJS release provides the same package through the `examples`
+extra:
 
 ```bash
 python -m pip install "pyjs[examples]"
@@ -42,17 +48,20 @@ python -m pip install "pyjs[examples]"
 
 Run each complete application with the command shown:
 
-| Example | Command |
-| --- | --- |
-| [Calculator](calculator/) | `python -m pyjs_examples.calculator` |
-| [Chatroom](chatroom/) | `python -m pyjs_examples.chatroom` |
-| [Kanban board](kanban/) | `python -m pyjs_examples.kanban` |
-| [Navigation workspace](navigation/) | `python -m pyjs_examples.navigation` |
-| [NativeScript Counter](nativescript_counter/) | `python -m pyjs_examples.nativescript_counter` |
-| [Space Invaders](space_invaders/) | `python -m pyjs_examples.space_invaders` |
-| [TodoMVC](todomvc/) | `python -m pyjs_examples.todomvc` |
-| [Component workspace](workspace/) | `python -m pyjs_examples.workspace` |
-| [Component catalog](catalog.py) | `python -m pyjs_examples.catalog` |
+- [Calculator](calculator/): `python -m pyjs_examples.calculator`
+- [Chatroom](chatroom/): `python -m pyjs_examples.chatroom`
+- [Django issue tracker](issue_tracker/):
+  `python -m pyjs_examples.issue_tracker`
+- [Kanban board](kanban/): `python -m pyjs_examples.kanban`
+- [Navigation workspace](navigation/):
+  `python -m pyjs_examples.navigation`
+- [NativeScript Counter](nativescript_counter/):
+  `python -m pyjs_examples.nativescript_counter`
+- [Space Invaders](space_invaders/):
+  `python -m pyjs_examples.space_invaders`
+- [TodoMVC](todomvc/): `python -m pyjs_examples.todomvc`
+- [Component workspace](workspace/): `python -m pyjs_examples.workspace`
+- [Component catalog](catalog.py): `python -m pyjs_examples.catalog`
 
 List or copy examples using the core scaffolding command:
 
@@ -63,10 +72,11 @@ pyjs create my-calculator --template pyjs_examples.calculator
 pyjs create --single-file my_counter.py --template pyjs_examples.counter
 ```
 
-The distribution registers modules and packages through the `pyjs.templates` entry-point group.
-PyJS infers file and directory templates from normal Python module structure instead of hardcoding
-a catalog.
+The distribution registers modules and packages through the `pyjs.templates`
+entry-point group. PyJS infers file and directory templates from normal Python
+module structure instead of hardcoding a catalog.
 
-The [focused samples](samples/) are small, executable sources intended for documentation excerpts
-and `pyjs create PROJECT --template NAME`. The initial catalog includes
-`pyjs_examples.samples.state_counter` and `pyjs_examples.samples.ui_dialog`.
+The [focused samples](samples/) are small, executable sources intended for
+documentation excerpts and `pyjs create PROJECT --template NAME`. The initial
+catalog includes `pyjs_examples.samples.state_counter` and
+`pyjs_examples.samples.ui_dialog`.

pyjs_examples-0.3.0/README.md

@@ -0,0 +1,54 @@
+# PyJS Examples
+
+This directory is the source tree for the separately installable
+`pyjs-examples` distribution. Setuptools maps this directory to the
+`pyjs_examples` import package, so the examples remain easy to browse in the
+repository while installing as an ordinary top-level package.
+
+From the repository root, install the core and examples from a source checkout:
+
+```bash
+uv sync
+```
+
+An installed PyJS release provides the same package through the `examples`
+extra:
+
+```bash
+python -m pip install "pyjs[examples]"
+```
+
+Run each complete application with the command shown:
+
+- [Calculator](calculator/): `python -m pyjs_examples.calculator`
+- [Chatroom](chatroom/): `python -m pyjs_examples.chatroom`
+- [Django issue tracker](issue_tracker/):
+  `python -m pyjs_examples.issue_tracker`
+- [Kanban board](kanban/): `python -m pyjs_examples.kanban`
+- [Navigation workspace](navigation/):
+  `python -m pyjs_examples.navigation`
+- [NativeScript Counter](nativescript_counter/):
+  `python -m pyjs_examples.nativescript_counter`
+- [Space Invaders](space_invaders/):
+  `python -m pyjs_examples.space_invaders`
+- [TodoMVC](todomvc/): `python -m pyjs_examples.todomvc`
+- [Component workspace](workspace/): `python -m pyjs_examples.workspace`
+- [Component catalog](catalog.py): `python -m pyjs_examples.catalog`
+
+List or copy examples using the core scaffolding command:
+
+```bash
+pyjs template
+pyjs template pyjs_examples.calculator
+pyjs create my-calculator --template pyjs_examples.calculator
+pyjs create --single-file my_counter.py --template pyjs_examples.counter
+```
+
+The distribution registers modules and packages through the `pyjs.templates`
+entry-point group. PyJS infers file and directory templates from normal Python
+module structure instead of hardcoding a catalog.
+
+The [focused samples](samples/) are small, executable sources intended for
+documentation excerpts and `pyjs create PROJECT --template NAME`. The initial
+catalog includes `pyjs_examples.samples.state_counter` and
+`pyjs_examples.samples.ui_dialog`.

{pyjs_examples-0.0.2 → pyjs_examples-0.3.0}/calculator/calculator.py

@@ -41,14 +41,14 @@ class InstallHandler:
         self.cache_name = cache_name
         self.assets = assets
 
-    @js(include=True)
+    @js.keep
     def handleEvent(self, event: ExtendableEvent):
         event.waitUntil(install_app_shell(self.cache_name, self.assets))
 
 
 @js
 class ActivateHandler:
-    @js(include=True)
+    @js.keep
     def handleEvent(self, event: ExtendableEvent):
         event.waitUntil(activate_app_shell())
 
@@ -58,7 +58,7 @@ class FetchHandler:
     def __init__(self, cache_name: str):
         self.cache_name = cache_name
 
-    @js(include=True)
+    @js.keep
     def handleEvent(self, event: FetchEvent):
         if event.request.method == "GET":
             event.respondWith(cache_first(event.request, self.cache_name))
@@ -96,7 +96,7 @@ class CalculatorKeyListener:
         self.kind = kind
         self.value = value
 
-    @js(include=True)
+    @js.keep
     async def handleEvent(self, event: Event):
         self.app.press(self.kind, self.value)
         if self.kind == "equals" and not self.app.error:

{pyjs_examples-0.0.2 → pyjs_examples-0.3.0}/chatroom/chatroom.py

@@ -1,7 +1,7 @@
-from typing import TypedDict
+from typing import cast
 
 from pyjs import effect, js, nojs, state
-from pyjs.javascript import JSON
+from pyjs.javascript import JSON, JSONObject
 from pyjs.web.dom import location, sessionStorage
 from pyjs.web.domx import button, form, input, ref, tag, tw
 from pyjs.web.events import Event, MessageEvent
@@ -9,7 +9,7 @@ from pyjs.web.network import WebSocket
 from pyjs.web.ui import Widget
 
 
-class ChatMessage(TypedDict):
+class ChatMessage(JSONObject):
     id: int
     room: str
     sender: str
@@ -17,7 +17,7 @@ class ChatMessage(TypedDict):
     time: str
 
 
-class ChatSnapshot(TypedDict):
+class ChatSnapshot(JSONObject):
     type: str
     room: str
     rooms: list[str]
@@ -26,13 +26,11 @@ class ChatSnapshot(TypedDict):
     message: str
 
 
-@js
-class OutgoingChatMessage:
-    def __init__(self, message_type: str, name: str, room: str, text: str):
-        self.type = message_type
-        self.name = name
-        self.room = room
-        self.text = text
+class OutgoingChatMessage(JSONObject):
+    type: str
+    name: str
+    room: str
+    text: str
 
 
 @js
@@ -40,7 +38,7 @@ class NameSubmitListener:
     def __init__(self, app: ChatRoomApp):
         self.app = app
 
-    @js(include=True)
+    @js.keep
     def handleEvent(self, event: Event):
         event.preventDefault()
         self.app.submit_name()
@@ -51,7 +49,7 @@ class RoomCreateListener:
     def __init__(self, app: ChatRoomApp):
         self.app = app
 
-    @js(include=True)
+    @js.keep
     def handleEvent(self, event: Event):
         event.preventDefault()
         self.app.create_room()
@@ -62,7 +60,7 @@ class MessageSubmitListener:
     def __init__(self, app: ChatRoomApp):
         self.app = app
 
-    @js(include=True)
+    @js.keep
     def handleEvent(self, event: Event):
         event.preventDefault()
         self.app.submit_message()
@@ -74,7 +72,7 @@ class RoomClickListener:
         self.app = app
         self.room = room
 
-    @js(include=True)
+    @js.keep
     def handleEvent(self, event: Event):
         self.app.switch_room(self.room)
 
@@ -84,7 +82,7 @@ class ReconnectClickListener:
     def __init__(self, app: ChatRoomApp):
         self.app = app
 
-    @js(include=True)
+    @js.keep
     def handleEvent(self, event: Event):
         self.app.connect()
 
@@ -94,7 +92,7 @@ class SignOutClickListener:
     def __init__(self, app: ChatRoomApp):
         self.app = app
 
-    @js(include=True)
+    @js.keep
     def handleEvent(self, event: Event):
         self.app.sign_out()
 
@@ -104,7 +102,7 @@ class SocketOpenListener:
     def __init__(self, app: ChatRoomApp):
         self.app = app
 
-    @js(include=True)
+    @js.keep
     def handleEvent(self, event: Event):
         self.app.socket_opened()
 
@@ -114,9 +112,9 @@ class SocketMessageListener:
     def __init__(self, app: ChatRoomApp):
         self.app = app
 
-    @js(include=True)
+    @js.keep
     def handleEvent(self, event: MessageEvent):
-        message: ChatSnapshot = JSON.parse(event.data)
+        message: ChatSnapshot = JSON.parse(cast(str, event.data))
         self.app.receive(message)
 
 
@@ -125,7 +123,7 @@ class SocketCloseListener:
     def __init__(self, app: ChatRoomApp):
         self.app = app
 
-    @js(include=True)
+    @js.keep
     def handleEvent(self, event: Event):
         self.app.socket_closed()
 
@@ -135,7 +133,7 @@ class SocketErrorListener:
     def __init__(self, app: ChatRoomApp):
         self.app = app
 
-    @js(include=True)
+    @js.keep
     def handleEvent(self, event: Event):
         self.app.show_error("The chat server could not be reached.")
 
@@ -494,10 +492,9 @@ class ChatRoomApp(Widget):
 
     def sign_out(self):
         sessionStorage.removeItem("pyjs-chatroom-display-name")
-        socket = self.socket
         if self.connection == "connected":
-            if socket is not None:
-                socket.close()
+            if self.socket is not None:
+                self.socket.close()
         self.name = ""
         self.name_input.value = ""
         self.show_sign_in()
@@ -516,7 +513,9 @@ class ChatRoomApp(Widget):
 
     def socket_opened(self):
         self.connection = "connected"
-        self.send(OutgoingChatMessage("join", self.name, self.room, ""))
+        self.send(
+            OutgoingChatMessage(type="join", name=self.name, room=self.room, text="")
+        )
 
     def socket_closed(self):
         if self.connection == "signed-out":
@@ -524,10 +523,9 @@ class ChatRoomApp(Widget):
         self.connection = "disconnected"
 
     def send(self, message: OutgoingChatMessage):
-        socket = self.socket
         if self.connection == "connected":
-            if socket is not None:
-                socket.send(JSON.stringify(message))
+            if self.socket is not None:
+                self.socket.send(JSON.stringify(message))
 
     def receive(self, message: ChatSnapshot):
         if message["type"] == "error":
@@ -654,21 +652,42 @@ class ChatRoomApp(Widget):
             )
 
     def switch_room(self, room: str):
-        self.send(OutgoingChatMessage("switch_room", self.name, room, ""))
+        self.send(
+            OutgoingChatMessage(
+                type="switch_room",
+                name=self.name,
+                room=room,
+                text="",
+            )
+        )
 
     def create_room(self):
         room = self.room_input.value.strip()
         if room == "":
             return
         self.room_input.value = ""
-        self.send(OutgoingChatMessage("create_room", self.name, room, ""))
+        self.send(
+            OutgoingChatMessage(
+                type="create_room",
+                name=self.name,
+                room=room,
+                text="",
+            )
+        )
 
     def submit_message(self):
         text = self.message_input.value.strip()
         if text == "":
             return
         self.message_input.value = ""
-        self.send(OutgoingChatMessage("message", self.name, self.room, text))
+        self.send(
+            OutgoingChatMessage(
+                type="message",
+                name=self.name,
+                room=self.room,
+                text=text,
+            )
+        )
 
     def show_error(self, message: str):
         self.error_banner.textContent = message

pyjs_examples-0.3.0/issue_tracker/README.md

@@ -0,0 +1,45 @@
+# Django issue tracker
+
+This conventional Django app uses models and relations for projects, issues,
+users, labels, milestones, comments, and activity. Shared Pydantic models form
+the typed client/server boundary. The app demonstrates SSR, generated client
+API proxies, nested resources, Django request validation, filtering, mutations,
+and model-driven forms.
+
+From the repository root, run:
+
+```console
+uv run python -m pyjs_examples.issue_tracker
+```
+
+For an installed examples package, install its optional dependencies first:
+
+```console
+pip install "pyjs-examples[issue_tracker]"
+```
+
+Open the printed URL. Create an issue, filter the list, add a comment, and close
+the issue. Every operation passes through the generated typed client and the
+Django adapter. The standalone runner migrates a temporary SQLite database and
+loads `fixtures/issue_tracker.json`, so each server process starts with the same
+sample project and removes its database when it stops.
+
+The application is divided by runtime responsibility:
+
+- `core.py` contains Pydantic values shared by the server and client;
+- `api.py` declares shared resources and supplies their ORM-backed server
+  implementations;
+- `ui.py` contains the transpiled and server-rendered interface; and
+- `server.py` connects the interface and API to Django HTTP views.
+
+The Django persistence models remain in `models.py`, as they would in an
+ordinary Django application.
+
+The standalone app is served through Django's ASGI interface. Open it in two
+browser windows and create or update an issue in either one. A shared
+`LiveSession` receives resource invalidations over SSE, batches the affected
+typed operations into one registered subscription, and updates the other
+window without a page refresh. Django evaluates the registered operations with
+the current SSE request and includes replacement values in the event. Each
+watched query retains its generated API operation and last submitted request,
+so live updates do not read partially edited form or filter controls.

pyjs_examples-0.3.0/issue_tracker/__init__.py

@@ -0,0 +1 @@
+"""A typed Django issue tracker built with PyJS."""

pyjs_examples-0.3.0/issue_tracker/__main__.py

@@ -0,0 +1,46 @@
+import os
+import shutil
+from pathlib import Path
+
+import django
+import uvicorn
+from django.conf import settings
+from django.core.asgi import get_asgi_application
+from django.core.management import call_command
+from django.db import connections
+
+
+def main():
+    os.environ.setdefault(
+        "DJANGO_SETTINGS_MODULE",
+        "pyjs_examples.issue_tracker.settings",
+    )
+    django.setup()
+
+    from pyjs_examples.issue_tracker.server import STATIC_ROOT, application
+
+    database_path = Path(settings.DATABASES["default"]["NAME"])
+    database_path.unlink(missing_ok=True)
+    call_command("migrate", interactive=False, verbosity=0)
+    call_command("loaddata", "issue_tracker", verbosity=0)
+    application.build(STATIC_ROOT / "issue_tracker")
+
+    host = "127.0.0.1"
+    port = int(os.environ.get("PYJS_PORT", "8000"))
+    url = f"http://{host}:{port}/"
+    print(f"Serving the PyJS issue tracker at {url}")
+
+    try:
+        uvicorn.run(
+            get_asgi_application(),
+            host=host,
+            port=port,
+            log_level="warning",
+        )
+    finally:
+        connections.close_all()
+        database_path.unlink(missing_ok=True)
+        shutil.rmtree(STATIC_ROOT, ignore_errors=True)
+
+
+main()