Merge pull request #10 from bcdev/forman/start_0.1.1

Started dvelopment of v0.1.1

Author: forman

README.md

@@ -1,10 +1,18 @@
 # RemoteState
 
 [![CI](https://github.com/bcdev/remotestate/actions/workflows/ci.yml/badge.svg)](https://github.com/bcdev/remotestate/actions/workflows/ci.yml)
+
+[![PyPI version](https://img.shields.io/pypi/v/remotestate?logo=pypi)](https://pypi.org/project/remotestate/)
+[![Python](https://img.shields.io/badge/Python-3776AB?logo=python&logoColor=white)](https://www.python.org/)
+[![FastAPI](https://img.shields.io/badge/FastAPI-009688?logo=fastapi&logoColor=white)](https://fastapi.tiangolo.com/)
+[![pydantic](https://img.shields.io/badge/pydantic-E92063?logo=pydantic&logoColor=white)](https://docs.pydantic.dev/)
+[![Ruff](https://img.shields.io/badge/Ruff-2C2F3A?logo=ruff&logoColor=white)](https://docs.astral.sh/ruff/)
+
+[![npm version](https://img.shields.io/npm/v/remotestate?logo=npm)](https://www.npmjs.com/package/remotestate)
 [![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
+[![React](https://img.shields.io/badge/React-61DAFB?logo=react&logoColor=black)](https://react.dev/)
 [![Vite](https://img.shields.io/badge/Vite-646CFF?logo=vite&logoColor=white)](https://vite.dev/)
-[![Ruff](https://img.shields.io/badge/Ruff-2C2F3A?logo=ruff&logoColor=white)](https://docs.astral.sh/ruff/)
-[![Python](https://img.shields.io/badge/Python-3776AB?logo=python&logoColor=white)](https://www.python.org/)
+
 [![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
 
 > **Python state, React UI.** One runtime for notebook apps and addon backends.
@@ -184,16 +192,16 @@ npm install remotestate
 
 ## Python API
 
-### `Store(initial: dict)`
+### `Store(initial: dict[str, Any])`
 
 Holds application state. Supports nested dicts, lists, Pydantic models, and dataclasses.
 
 ```python
-store = rs.Store({"items": [], "user": UserModel(name="Norman")})
-store.get("user.name")          # "Norman"
+store = rs.Store({"items": [], "user": UserModel(name="forman")})
+store.get("user.name")          # "forman"
 store.set("items[0].label", "foo")
 ```
-
+^^
 Paths use a JSONPath-inspired syntax such as `user.name` or `items[3].label`.
 
 ### `@action`
@@ -219,35 +227,38 @@ async def process(self, path: str) -> dict:
     return result
 ```
 
-### `rs.serve(service, *, dist_dir, host, port, open_browser, open_iframe, iframe_height)`
+### `rs.serve(service, *, ui_dist, app, open_browser, open_iframe, iframe_height, host, port, **uvicorn_settings)`
 
 Starts the Remote State server and connects it to a frontend bundle.
 
-| Parameter | Default | Description |
-|---|---|---|
-| `service` | required | A `Service` instance |
-| `dist_dir` | `None` | Path to the React build output (`dist/`) |
-| `host` | `"localhost"` | Server host |
-| `port` | `9753` | Server port |
-| `open_browser` | auto | Open in browser, default outside Jupyter |
-| `open_iframe` | auto | Render as IFrame, default in Jupyter |
-| `iframe_height` | `600` | IFrame height in pixels |
+| Parameter          | Default       | Description                                                     |
+|--------------------|---------------|-----------------------------------------------------------------|
+| `service`          | required      | A `Service` instance                                            |
+| `ui_dist`          | `None`        | Path to the React build output (`dist/`) or URL                 |
+| `mounts`           | `None`        | Mapping of an endpoint paths to local directories               |
+| `app`              | `None`        | [FastAPI](https://fastapi.tiangolo.com/) instance               |
+| `open_browser`     | auto          | Open in browser, default outside Jupyter                        |
+| `open_iframe`      | auto          | Render as IFrame, default in Jupyter                            |
+| `iframe_height`    | `400`         | IFrame height in pixels                                         |
+| `host`             | `"localhost"` | Server host                                                     |
+| `port`             | `9753`        | Server port                                                     |
+| `uvicorn_settings` | -             | Additional [uvicorn settings]((https://uvicorn.dev/settings/)   |
 
 Re-running the same Jupyter cell restarts the server automatically.
 
 ---
 
 ## TypeScript API
 
-### `createRemoteState<TService>(url)`
+### `createRemoteState<S>(url)`
 
 Creates a typed RemoteState bridge.
 
 ```typescript
 const remoteState = createRemoteState<MyService>("ws://localhost:9753/ws");
 ```
 
-### `RemoteStateProvider` and `useRemoteStateClient<TService>()`
+### `RemoteStateProvider` and `useRemoteStateClient<S>()`
 
 React context wrapper for a RemoteState bridge bound to a WebSocket URL, plus
 a hook to access it.
@@ -260,7 +271,7 @@ a hook to access it.
 const remoteState = useRemoteStateClient<MyService>();
 ```
 
-### `useState<T>(path, initialValue?)`
+### `useRemoteState<T>(path, initialValue?)`
 
 React-like state hook backed by the Python store. It returns `[value, setValue]`.
 
@@ -275,7 +286,7 @@ Calls a Python `@action`. Fire-and-forget by default.
 
 ```typescript
 await remoteState.action("increment");
-await remoteState.action("set_name", ["Norman"]);
+await remoteState.action("set_name", ["forman"]);
 await remoteState.action("save", [], {}, { awaitInvalidate: true });
 ```
 
@@ -284,7 +295,7 @@ await remoteState.action("save", [], {}, { awaitInvalidate: true });
 Calls a Python `@query` and returns the result.
 
 ```typescript
-const result = await remoteState.query("compute", [5.0]);
+const result = await remoteState.query("compute", [2.5]);
 ```
 
 ### `useRemoteStateValue<T>(path)`
@@ -297,9 +308,7 @@ re-renders on invalidation.
 - `RemoteState` is the bridge object that used to be called `Client`.
 - `useRemoteStateClient()` returns that bridge object.
 - `useRemoteStore()` returns the cached store view used by the hooks.
-- `useState()` remains the ergonomic path-bound state hook for components.
-- We use `useRemoteStateClient()` instead of `useRemoteState()` to keep it
-  clearly distinct from `useState()` and `useRemoteStore()`.
+- `useRemoteState()` remains the ergonomic path-bound state hook for components.
 
 ---
 

remotestate-demo/package-lock.json

@@ -0,0 +1,6 @@
+## Version 0.1.1 (in development)
+
+
+## Version 0.1.0
+
+Initial release from 2026-06-09.

remotestate-py/CHANGES.md

@@ -1,5 +1,16 @@
 # RemoteState - Python
 
+[![CI](https://github.com/bcdev/remotestate/actions/workflows/ci.yml/badge.svg)](https://github.com/bcdev/remotestate/actions/workflows/ci.yml)
+
+[![PyPI version](https://img.shields.io/pypi/v/remotestate?logo=pypi)](https://pypi.org/project/remotestate/)
+[![Python](https://img.shields.io/badge/Python-3776AB?logo=python&logoColor=white)](https://www.python.org/)
+[![FastAPI](https://img.shields.io/badge/FastAPI-009688?logo=fastapi&logoColor=white)](https://fastapi.tiangolo.com/)
+[![pydantic](https://img.shields.io/badge/pydantic-E92063?logo=pydantic&logoColor=white)](https://docs.pydantic.dev/)
+[![Ruff](https://img.shields.io/badge/Ruff-2C2F3A?logo=ruff&logoColor=white)](https://docs.astral.sh/ruff/)
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+
 `remotestate` is the Python runtime for the _RemoteState_ library.
 
 It gives you:

remotestate-py/README.md

@@ -1,6 +1,6 @@
 [project]
 name = "remotestate"
-version = "0.1.0"
+version = "0.1.1.dev0"
 authors = [{name = "forman"}]
 description = "Python state, React UI."
 readme = "README.md"

remotestate-py/pyproject.toml

@@ -0,0 +1,6 @@
+## Version 0.1.1 (in development)
+
+
+## Version 0.1.0
+
+Initial release from 2026-06-09.

remotestate-ts/CHANGES.md

@@ -1,5 +1,15 @@
 # RemoteState - TypeScript/React
 
+[![CI](https://github.com/bcdev/remotestate/actions/workflows/ci.yml/badge.svg)](https://github.com/bcdev/remotestate/actions/workflows/ci.yml)
+
+[![npm version](https://img.shields.io/npm/v/remotestate?logo=npm)](https://www.npmjs.com/package/remotestate)
+[![TypeScript](https://img.shields.io/badge/TypeScript-3178C6?logo=typescript&logoColor=white)](https://www.typescriptlang.org/)
+[![React](https://img.shields.io/badge/React-61DAFB?logo=react&logoColor=black)](https://react.dev/)
+[![Vite](https://img.shields.io/badge/Vite-646CFF?logo=vite&logoColor=white)](https://vite.dev/)
+
+[![License: MIT](https://img.shields.io/badge/License-MIT-yellow.svg)](https://opensource.org/licenses/MIT)
+
+
 `remotestate` is the TypeScript and React bridge of the _RemoteState_ library.
 
 This package provides the frontend client, provider, and hooks that pair with
@@ -14,7 +24,7 @@ npm install remotestate
 ## Use
 
 ```ts
-import { RemoteStateProvider, useRemoteStateClient } from "remotestate";
+import { RemoteStateProvider, useRemoteState } from "remotestate";
 ```
 
 For full project documentation, see the repository root README:

remotestate-ts/README.md

@@ -1,6 +1,6 @@
 {
   "name": "remotestate",
-  "version": "0.1.0",
+  "version": "0.1.1-dev.0",
   "description": "Python state, React UI.",
   "type": "module",
   "main": "./dist/remotestate.js",