open-codex-ui 0.1.4__py3-none-any.whl

open_codex_ui-0.1.4.dist-info/METADATA

@@ -0,0 +1,249 @@
+Metadata-Version: 2.4
+Name: open-codex-ui
+Version: 0.1.4
+Summary: Remote-friendly web workspace for Codex sessions
+Requires-Python: >=3.12
+Description-Content-Type: text/markdown
+Requires-Dist: open-codex-bridge>=0.1.9
+Requires-Dist: granian[reload]>=2.7.2
+Requires-Dist: httpx>=0.28.1
+Requires-Dist: litestar>=2.21.1
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: yier-agents>=0.1.3
+
+<p align="center">
+  <img src="web/public/brand/open-codex-ui-logo.svg" alt="Open Codex UI" width="520">
+</p>
+
+# open-codex-ui
+
+Remote-friendly Codex web workspace for continuing sessions from desktop and mobile browsers.
+
+## Resume
+[一二Resume](https://baike.baidu.com/item/%E4%B8%80%E4%BA%8C/23434669)
+
+## Requirements
+
+- [`uv`](https://docs.astral.sh/uv/) for running the published application
+- Python 3.12+, Node.js 20+, and `pnpm` only for source development
+
+## Install
+
+Run the published application without a permanent installation:
+
+```bash
+uvx open-codex-ui
+```
+
+The wheel includes the compiled frontend and starts in production mode. For a
+persistent command, install it as a uv tool:
+
+```bash
+uv tool install open-codex-ui
+open-codex-ui
+```
+
+For source development, install the backend dependencies:
+
+```bash
+uv sync
+```
+
+Codex workspace support uses the published `open-codex-bridge` package from PyPI.
+
+Then install the frontend dependencies:
+
+```bash
+cd web
+pnpm install
+```
+
+## Authentication
+
+This app now supports password protection for deployed environments.
+
+Enable auth with either:
+
+- `YIER_AUTH_PASSWORD`
+- `YIER_AUTH_PASSWORD_HASH`
+
+Plain password example:
+
+```bash
+export YIER_AUTH_PASSWORD='change-this-password'
+```
+
+Hashed password example:
+
+```bash
+uv run python -c "from yier_web.auth import hash_password; print(hash_password('change-this-password'))"
+export YIER_AUTH_PASSWORD_HASH='paste-generated-hash-here'
+```
+
+Optional auth settings:
+
+- `YIER_AUTH_SECRET`: optional extra signing secret for session cookies
+- `YIER_AUTH_SESSION_TTL_HOURS`: cookie lifetime in hours, default is `168`
+- `YIER_CODEX_EMBED_TOKEN`: token for unauthenticated Codex iframe access
+
+If neither password variable is set, authentication is disabled.
+
+## Codex Iframe Embed
+
+See [IFRAME.md](./IFRAME.md) for iframe setup, authentication, and the
+`postMessage` API.
+
+## Development Startup
+
+Development mode is different from production:
+
+- The backend should run with `--debug`
+- The frontend should run with Vite dev server
+- In this mode, the backend proxies frontend requests to `http://127.0.0.1:5173`
+
+Recommended one-command startup:
+
+```bash
+uv run open-codex-ui-dev
+```
+
+This starts:
+
+- frontend: `pnpm dev`
+- backend: debug mode with reload
+
+If you prefer split terminals:
+
+Frontend only:
+
+```bash
+uv run open-codex-ui-dev-web
+```
+
+Backend only:
+
+```bash
+uv run open-codex-ui-dev-backend
+```
+
+You can also override backend bind settings:
+
+```bash
+uv run open-codex-ui-dev --host 127.0.0.1 --port 9999
+uv run open-codex-ui-dev-backend --host 127.0.0.1 --port 9999
+```
+
+Default address:
+
+- App: `http://127.0.0.1:9999`
+- Vite dev server: `http://127.0.0.1:5173`
+
+Notes:
+
+- Keep `pnpm dev` running, otherwise the backend cannot proxy the frontend in debug mode.
+- API requests still go through the Python server at port `9999`.
+
+## Production Startup
+
+The published wheel includes the compiled frontend and does not use the Vite
+dev server:
+
+```bash
+uvx open-codex-ui
+```
+
+The server listens on `127.0.0.1:9999` by default. Bind to the local network
+explicitly when needed:
+
+```bash
+uvx open-codex-ui --host 0.0.0.0 --port 9999
+```
+
+When running from a source checkout, build the frontend before starting:
+
+```bash
+uv run open-codex-ui-build-web
+uv run open-codex-ui-prod
+```
+
+In production mode:
+
+- The backend serves the compiled assets packaged under `yier_web/static`
+- No Vite proxy is used
+- Authentication should usually be enabled with `YIER_AUTH_PASSWORD` or `YIER_AUTH_PASSWORD_HASH`
+
+Production example:
+
+```bash
+export YIER_AUTH_PASSWORD='change-this-password'
+uvx open-codex-ui --host 0.0.0.0 --port 9999
+```
+
+## Common Commands
+
+Backend tests:
+
+```bash
+uv run --all-packages pytest
+```
+
+Targeted backend tests:
+
+```bash
+uv run --all-packages pytest tests/test_codex_backend.py tests/test_codex_workspace.py tests/test_app.py
+```
+
+Backend compile check:
+
+```bash
+uv run python -m compileall yier_web
+```
+
+Frontend unit tests:
+
+```bash
+cd web
+pnpm test:unit
+```
+
+Frontend type check:
+
+```bash
+cd web
+pnpm type-check
+```
+
+Frontend production build:
+
+```bash
+uv run open-codex-ui-build-web
+```
+
+## Startup Summary
+
+Development:
+
+```bash
+uv run open-codex-ui-dev
+```
+
+Production:
+
+```bash
+export YIER_AUTH_PASSWORD='change-this-password'
+uvx open-codex-ui --host 0.0.0.0 --port 9999
+```
+
+## Available uv Scripts
+
+Development:
+
+- `uv run open-codex-ui-dev`: start frontend and backend together
+- `uv run open-codex-ui-dev-web`: start Vite only
+- `uv run open-codex-ui-dev-backend`: start backend only in debug mode
+
+Production:
+
+- `uvx open-codex-ui`: run the published wheel in production mode
+- `uv run open-codex-ui-build-web`: build frontend assets
+- `uv run open-codex-ui-prod`: start backend in production mode

open_codex_ui-0.1.4.dist-info/RECORD

@@ -0,0 +1,40 @@
+yier_web/__init__.py,sha256=-r2mRpa4wroHvmUsgEW-KHSGwYwKBWBVfacqLSTXBjU,205
+yier_web/app.py,sha256=vL0k_CyXF34QTNgtb8APT4AMU3CMqlnld0wGfgiWDns,7183
+yier_web/auth.py,sha256=69hRO2QbLVE-f77EldFUQz9JXD6EdC9ErUmUWgyjdDE,8533
+yier_web/cli.py,sha256=t6W5E9qBEF4Plf0DhB-YB-RR5S-o_8rz3jyyhBNMZ8k,4487
+yier_web/config.py,sha256=KpoOu5Oq0Roqxga7p8ioeZ3HNNqINNx-UnaI_ON-4OE,25515
+yier_web/directory_picker.py,sha256=clnA-nDqXBWuXxCmylM0tUkUd4k6mtd3Orra8uZVW14,3149
+yier_web/event_stream.py,sha256=G4ekSXUOHyymfBnPJHdR_cPm5dhO9Trty558F4Kpwyc,854
+yier_web/frontend.py,sha256=JDfRqHj3rShl2ASD2Je-5ya7dC2a2jElbsfpZimqKIs,6607
+yier_web/schemas.py,sha256=h-p2CwQqFebaGXBbBBxoUieTMaxhZ6szhubHrgdzrUs,15410
+yier_web/codex/__init__.py,sha256=HOpAEcNgvHUEbRPUxdueiVzR9dHCZcZ8Kdrge-JSDpA,86
+yier_web/codex/ipc_manager.py,sha256=10hd2xDCWms7BrGBU0pAb8rg-Zohquszp104yeGx-Z8,63588
+yier_web/codex/session_events.py,sha256=USaxcbLZ8xm5ZW8JavVRxlPh-O7v2_JAjJdu_ZpnTl4,3423
+yier_web/codex/ws_commands.py,sha256=SCkajF0FIKG7U4ZyIsjjajTmW4PlVZJC9BDbVIu5InE,12130
+yier_web/routes/__init__.py,sha256=e78z7qWu_A8iBECHGSsfkuHgl53o14ck34cm94yRRAI,351
+yier_web/routes/codex.py,sha256=Hg2bao3OP5Pyq2RrZake7ufeUC3Nlc8LWj8giqkAHwA,18994
+yier_web/routes/core.py,sha256=OyLJzX_utJG7X2e1E_uYxlbF9hwkIXDeYw1qLRErq7w,9337
+yier_web/static/favicon.ico,sha256=23SrC3gzjB93j4OYxF9BA8ma6g6EWjEYp3ULTur9NEU,4286
+yier_web/static/favicon.svg,sha256=LD-C-zFycjHm88vsZ8CufvM5FtTgSXBCKrm1aF497-Y,5456
+yier_web/static/index.html,sha256=tw1-6vi7ZkHiVVzELn5Kgxfj28flOEQcTLsjkzoYCGY,461
+yier_web/static/assets/CodexEmbedView-CN_-Mhe2.js,sha256=lw6gRNcZEqy8TbAvchvq43g_KzgxP097BYJ8LG4mNRY,13167
+yier_web/static/assets/CodexView-wpI61iXa.js,sha256=H_2hX3G7Vaje0Kli4_20tei3R8qA0KGWnd-6wpQbwq0,140981
+yier_web/static/assets/LoginView-CELCom2O.js,sha256=OIM2-1NDoICAUfMQWBq2JMdRQo10y2y0gzpEU6TsvAM,25258
+yier_web/static/assets/api-CeihACIV.js,sha256=46tjWnbZqNHmu01V2FywnWjlz2jiqAxSlrp4cbuCVRM,89285
+yier_web/static/assets/index-BdFqJ-Kl.css,sha256=p_DpD0lihpNIfCS7SFdqsWLz7HoRVcntpSYVQNgeeDE,225466
+yier_web/static/assets/index-CjVNk6ja.js,sha256=TFF8oghOBwOo01FHwoMwcRY7QU4d0e3XmkFKYAh36as,262843
+yier_web/static/assets/index-mSBvq1p8.js,sha256=ZI-MHBca6RRdu4FS0nbcFAcB4VlNNaya_GQTdnf4ZlI,7940
+yier_web/static/assets/open-codex-ui-icon-DKJ1ZKj4.svg,sha256=LD-C-zFycjHm88vsZ8CufvM5FtTgSXBCKrm1aF497-Y,5456
+yier_web/static/assets/primeicons-C6QP2o4f.woff2,sha256=nupuC8uXTsVo_cse7BgtO1ODo6I4maaQFAssAWeIaII,35148
+yier_web/static/assets/primeicons-DMOk5skT.eot,sha256=mH8j6t-nDGAydqccPJdcjQU02ccZ2Kbj2WUAXnuTdHs,85156
+yier_web/static/assets/primeicons-Dr5RGzOO.svg,sha256=NsVM7PypR6aRPJbfiEMAzhQQjE2MscskGWkyE0L4kMk,342525
+yier_web/static/assets/primeicons-MpK4pl85.ttf,sha256=3Ilf7p884bDq8WtLn6sgB3_CmB5sCzMuTJfBdoMvwFs,84980
+yier_web/static/assets/primeicons-WjwUDZjB.woff,sha256=9dHSGV4FuAhZU6p9ULLncHDNESDgEAqGAHcapboRoB4,85056
+yier_web/static/assets/useCodexWorkspace-6QenDzvb.css,sha256=5zqWEvm9Rk9W_0yFhBM38z9_Z-rQ8kKweqgVj1rNzjk,688
+yier_web/static/assets/useCodexWorkspace-D1rCOO1x.js,sha256=vARGj-G54vKSYdH2VdwcGJww7O4mfMHu2oOebFQ-ORU,535100
+yier_web/static/brand/open-codex-ui-logo.svg,sha256=1b_HKKMW5KJJRFKbMfVMUtYgrvCm9sIIqq34hcigGsk,4659
+open_codex_ui-0.1.4.dist-info/METADATA,sha256=JdXS10nB8qKFgUcdXv7JWCZGjjrX7exGUzql9EL77Bs,5129
+open_codex_ui-0.1.4.dist-info/WHEEL,sha256=K260EYznzXsJYBQGqmI8VTxEdiZYNvDZwW9cBh9-_MA,91
+open_codex_ui-0.1.4.dist-info/entry_points.txt,sha256=msxW84jsEug9cqyQb1KtvAH67L6YucmA9kREUoPCSbo,275
+open_codex_ui-0.1.4.dist-info/top_level.txt,sha256=oz3Nm_WgVsyUMc_ygyvELnJvP6nllfVQu1cn_XRHZKU,9
+open_codex_ui-0.1.4.dist-info/RECORD,,

open_codex_ui-0.1.4.dist-info/WHEEL

@@ -0,0 +1,5 @@
+Wheel-Version: 1.0
+Generator: setuptools (83.0.0)
+Root-Is-Purelib: true
+Tag: py3-none-any
+

open_codex_ui-0.1.4.dist-info/entry_points.txt

@@ -0,0 +1,7 @@
+[console_scripts]
+open-codex-ui = yier_web.cli:prod
+open-codex-ui-build-web = yier_web.cli:build_web
+open-codex-ui-dev = yier_web.cli:dev
+open-codex-ui-dev-backend = yier_web.cli:dev_backend
+open-codex-ui-dev-web = yier_web.cli:dev_web
+open-codex-ui-prod = yier_web.cli:prod

open_codex_ui-0.1.4.dist-info/top_level.txt

@@ -0,0 +1 @@
+yier_web

yier_web/__init__.py

@@ -0,0 +1,6 @@
+import logging
+from yier_web.app import AppServices, app, build_services, create_app
+
+logging.getLogger("httpx").setLevel(logging.WARNING)
+
+__all__ = ["AppServices", "app", "build_services", "create_app"]

yier_web/app.py

@@ -0,0 +1,223 @@
+from __future__ import annotations
+
+import asyncio
+from contextlib import asynccontextmanager
+from dataclasses import dataclass
+import os
+from pathlib import Path
+import signal
+from typing import Any, AsyncIterator
+
+from litestar import Litestar, Request, Router, get, websocket
+from litestar.connection import WebSocket
+from litestar.datastructures import State
+from litestar.exceptions import HTTPException
+from litestar.logging import LoggingConfig
+from litestar.response import Response
+from litestar.status_codes import HTTP_404_NOT_FOUND
+
+from yier_web.auth import AuthService
+from yier_web.config import AppConfigService
+from yier_web.codex.ipc_manager import CodexIpcManager
+from yier_web.directory_picker import LocalDirectoryPickerService
+from yier_web.event_stream import EventStreamBroker
+from yier_web.frontend import FrontendService
+from yier_web.routes import (
+    AuthController,
+    CodexController,
+    ConfigController,
+    EventsController,
+    HealthController,
+    SystemController,
+)
+from yier_web.routes.core import (
+    wait_for_event_stream_item as wait_for_event_stream_item,
+)
+
+
+@dataclass(slots=True)
+class AppServices:
+    config_service: AppConfigService
+    codex_ipc_manager: CodexIpcManager
+    event_broker: EventStreamBroker
+    frontend_service: FrontendService
+    directory_picker_service: LocalDirectoryPickerService
+    auth_service: AuthService
+
+
+def _env_flag(name: str) -> bool:
+    return os.getenv(name, "").strip().lower() not in {
+        "",
+        "0",
+        "false",
+        "no",
+        "off",
+    }
+
+
+def _build_logging_config(*, debug: bool) -> LoggingConfig:
+    return LoggingConfig(
+        root={"level": "DEBUG" if debug else "INFO", "handlers": ["queue_listener"]},
+        formatters={
+            "standard": {
+                "format": "%(asctime)s %(levelname)s %(name)s - %(message)s",
+            }
+        },
+        loggers={
+            "granian": {"level": "INFO", "handlers": ["queue_listener"]},
+            "httpx": {"level": "WARNING", "handlers": ["queue_listener"]},
+            "httpcore": {"level": "WARNING", "handlers": ["queue_listener"]},
+            "httpcore.connection": {"level": "WARNING", "handlers": ["queue_listener"]},
+            "httpcore.http11": {"level": "WARNING", "handlers": ["queue_listener"]},
+        },
+        log_exceptions="always",
+        disable_stack_trace={HTTP_404_NOT_FOUND},
+    )
+
+
+def install_shutdown_signal_bridge(shutdown_event: asyncio.Event) -> None:
+    try:
+        loop = asyncio.get_running_loop()
+    except RuntimeError:
+        return
+
+    if getattr(loop, "_yier_shutdown_signal_bridge_installed", False):
+        return
+
+    signal_handlers = getattr(loop, "_signal_handlers", None)
+    if not isinstance(signal_handlers, dict):
+        return
+
+    installed = False
+    for signum in (signal.SIGINT, signal.SIGTERM):
+        existing_handle = signal_handlers.get(signum)
+        if existing_handle is None or not hasattr(existing_handle, "_run"):
+            continue
+
+        def chained_handler(
+            handle: Any = existing_handle,
+            current_loop: asyncio.AbstractEventLoop = loop,
+        ) -> None:
+            shutdown_event.set()
+            current_loop.call_soon(handle._run)
+
+        try:
+            loop.add_signal_handler(signum, chained_handler)
+        except (NotImplementedError, RuntimeError, ValueError):
+            continue
+        installed = True
+
+    if installed:
+        setattr(loop, "_yier_shutdown_signal_bridge_installed", True)
+
+
+def build_services(
+    project_root: Path | None = None,
+    home_dir: Path | None = None,
+) -> AppServices:
+    resolved_root = (project_root or Path.cwd()).resolve()
+    config_service = AppConfigService(project_root=resolved_root, home_dir=home_dir)
+    event_broker = EventStreamBroker()
+    return AppServices(
+        config_service=config_service,
+        codex_ipc_manager=CodexIpcManager(
+            config_service=config_service,
+            event_broker=event_broker,
+        ),
+        event_broker=event_broker,
+        frontend_service=FrontendService(
+            debug=_env_flag("YIER_DEBUG"),
+        ),
+        directory_picker_service=LocalDirectoryPickerService(),
+        auth_service=AuthService(),
+    )
+
+
+api_router = Router(
+    path="/api",
+    route_handlers=[
+        AuthController,
+        HealthController,
+        ConfigController,
+        SystemController,
+        CodexController,
+        EventsController,
+    ],
+)
+
+
+@get(path=["/", "/{path:path}"], include_in_schema=False)
+async def frontend_entry(
+    request: Request[Any, Any, Any], state: State, path: str = ""
+) -> Response:
+    if path.startswith("api/"):
+        raise HTTPException(status_code=HTTP_404_NOT_FOUND)
+    return await state.frontend_service.handle_request(request, path)
+
+
+@websocket(path=["/", "/{path:path}"], include_in_schema=False)
+async def frontend_entry_websocket(
+    socket: WebSocket,
+    path: str = "",
+) -> None:
+    if path.startswith("api/"):
+        await socket.accept()
+        await socket.close(code=1008, reason="WebSocket route not found.")
+        return
+
+    await socket.app.state.frontend_service.handle_websocket(socket, path)
+
+
+def create_app(
+    project_root: Path | None = None,
+    home_dir: Path | None = None,
+    services: AppServices | None = None,
+) -> Litestar:
+    resolved_root = (project_root or Path.cwd()).resolve()
+    debug = _env_flag("YIER_DEBUG")
+    app_services = services or build_services(
+        project_root=resolved_root, home_dir=home_dir
+    )
+
+    async def before_request(request: Request[Any, Any, Any]) -> Response | None:
+        auth_service = app_services.auth_service
+        if not auth_service.enabled:
+            return None
+
+        request_path = request.url.path
+        if auth_service.is_public_path(request_path):
+            return None
+        if auth_service.is_authenticated(request):
+            return None
+        if request_path.startswith("/api/"):
+            return auth_service.build_unauthorized_api_response()
+        return auth_service.build_login_redirect(request)
+
+    @asynccontextmanager
+    async def lifespan(app: Litestar) -> AsyncIterator[None]:
+        shutdown_event = asyncio.Event()
+        install_shutdown_signal_bridge(shutdown_event)
+        app.state.shutdown_event = shutdown_event
+        app.state.config_service = app_services.config_service
+        app.state.codex_ipc_manager = app_services.codex_ipc_manager
+        app.state.event_broker = app_services.event_broker
+        app.state.frontend_service = app_services.frontend_service
+        app.state.directory_picker_service = app_services.directory_picker_service
+        app.state.auth_service = app_services.auth_service
+        await app_services.codex_ipc_manager.start()
+        try:
+            yield
+        finally:
+            shutdown_event.set()
+            await app_services.codex_ipc_manager.stop()
+
+    return Litestar(
+        route_handlers=[api_router, frontend_entry, frontend_entry_websocket],
+        before_request=before_request,
+        lifespan=[lifespan],
+        debug=debug,
+        logging_config=_build_logging_config(debug=debug),
+    )
+
+
+app = create_app()