Upload folder using huggingface_hub

README.md

@@ -235,6 +235,8 @@ the root `Dockerfile` installs from `pyproject.toml` and `uv.lock` via `uv sync
 
 for `openenv push`, the CLI stages the repository and promotes `server/Dockerfile` to the deployment root. `server/Dockerfile` mirrors the same metadata driven build path so local docker builds and pushed builds stay aligned.
 
+the FastAPI server also includes a minimal OpenEnv web compatibility shim so pushed Spaces serve [`/web`](sysadmin_env/server.py) successfully. the shim keeps the existing [`/reset`](sysadmin_env/server.py), [`/step`](sysadmin_env/server.py), [`/state`](sysadmin_env/server.py), and [`/ws`](sysadmin_env/server.py) interfaces unchanged while adding helper routes at [`/web`](sysadmin_env/server.py), [`/web/metadata`](sysadmin_env/server.py), [`/web/reset`](sysadmin_env/server.py), [`/web/step`](sysadmin_env/server.py), and [`/web/state`](sysadmin_env/server.py).
+
 ```bash
 docker build -t sysadmin-env .
 ```

sysadmin_env.egg-info/PKG-INFO

@@ -136,7 +136,7 @@ reward is shaped over the full trajectory.
 the baseline inference script supports the required submission variables.
 
 ```dotenv
-# preferred submission credential. `OPENAI_API_KEY` and `API_KEY` are also accepted.
+# submission credential used by the baseline agent.
 HF_TOKEN="your_api_key_here"
 MODEL_NAME="gpt-5.4"
 API_BASE_URL="https://api.openai.com/v1"
@@ -154,6 +154,13 @@ EPISODE_TIMEOUT_SECONDS="600"
 
 this repository follows the standard layout expected after `openenv init`.
 
+`openenv push` performs a stricter structure check than `openenv validate`. to satisfy that check, the repository includes thin required shim files at the root and under `server/`.
+
+- `__init__.py`
+- `client.py`
+- `models.py`
+- `server/Dockerfile`
+
 ```bash
 openenv validate
 ```
@@ -170,7 +177,7 @@ for reproducible local setup, `pyproject.toml` and `uv.lock` define the environm
 uv sync --extra dev
 ```
 
-the repository targets python 3.11 for validator parity and includes `.python-version` for `uv` discovery. if your host only exposes a newer incompatible interpreter, install the matching runtime first.
+the repository targets python 3.11 for validator parity and includes `.python-version` for `uv` discovery. if your host only exposes a newer interpreter outside this supported range, install the matching runtime first.
 
 ```bash
 uv python install 3.11
@@ -242,6 +249,10 @@ this repository is prepared for a Hugging Face docker space and the runtime entr
 
 the root `Dockerfile` installs from `pyproject.toml` and `uv.lock` via `uv sync --locked`, then starts the environment with `uv run server`.
 
+for `openenv push`, the CLI stages the repository and promotes `server/Dockerfile` to the deployment root. `server/Dockerfile` mirrors the same metadata driven build path so local docker builds and pushed builds stay aligned.
+
+the FastAPI server also includes a minimal OpenEnv web compatibility shim so pushed Spaces serve [`/web`](sysadmin_env/server.py) successfully. the shim keeps the existing [`/reset`](sysadmin_env/server.py), [`/step`](sysadmin_env/server.py), [`/state`](sysadmin_env/server.py), and [`/ws`](sysadmin_env/server.py) interfaces unchanged while adding helper routes at [`/web`](sysadmin_env/server.py), [`/web/metadata`](sysadmin_env/server.py), [`/web/reset`](sysadmin_env/server.py), [`/web/step`](sysadmin_env/server.py), and [`/web/state`](sysadmin_env/server.py).
+
 ```bash
 docker build -t sysadmin-env .
 ```

sysadmin_env.egg-info/SOURCES.txt

@@ -1,5 +1,7 @@
 README.md
+client.py
 inference.py
+models.py
 pyproject.toml
 server/__init__.py
 server/app.py

sysadmin_env.egg-info/top_level.txt

@@ -1,3 +1,5 @@
+client
 inference
+models
 server
 sysadmin_env

sysadmin_env/server.py

@@ -12,6 +12,7 @@ from fastapi import FastAPI
 from fastapi import HTTPException
 from fastapi import WebSocket
 from fastapi import WebSocketDisconnect
+from fastapi.responses import HTMLResponse
 from fastapi.responses import JSONResponse
 from pydantic import ValidationError
 
@@ -140,6 +141,7 @@ class EpisodeManager:
 
 def create_app() -> FastAPI:
     manager = EpisodeManager(base_dir=Path.cwd() / "assets")
+    web_metadata_payload = _build_web_metadata()
 
     @asynccontextmanager
     async def lifespan(app: FastAPI):
@@ -156,12 +158,7 @@ def create_app() -> FastAPI:
     app.state.episode_manager = manager
     app.state.http_session = HttpSessionState()
 
-    @app.get("/health")
-    async def health() -> JSONResponse:
-        return JSONResponse({"status": "ok"})
-
-    @app.post("/reset", response_model=StepResult)
-    async def reset(payload: ResetRequest | None = None) -> StepResult:
+    async def reset_episode(payload: ResetRequest | None = None) -> StepResult:
         manager: EpisodeManager = app.state.episode_manager
         session: HttpSessionState = app.state.http_session
         if session.episode is not None:
@@ -191,8 +188,7 @@ def create_app() -> FastAPI:
         session.last_state = state
         return StepResult(observation=observation, state=state)
 
-    @app.post("/step", response_model=StepResult)
-    async def step(payload: StepRequest) -> StepResult:
+    async def step_episode(payload: StepRequest) -> StepResult:
         manager: EpisodeManager = app.state.episode_manager
         session: HttpSessionState = app.state.http_session
         if session.episode is None or session.episode_id is None:
@@ -208,6 +204,18 @@ def create_app() -> FastAPI:
             session.episode = None
         return StepResult(observation=observation, state=state)
 
+    @app.get("/health")
+    async def health() -> JSONResponse:
+        return JSONResponse({"status": "ok"})
+
+    @app.post("/reset", response_model=StepResult)
+    async def reset(payload: ResetRequest | None = None) -> StepResult:
+        return await reset_episode(payload)
+
+    @app.post("/step", response_model=StepResult)
+    async def step(payload: StepRequest) -> StepResult:
+        return await step_episode(payload)
+
     @app.get("/state", response_model=EnvironmentState)
     async def state() -> EnvironmentState:
         session: HttpSessionState = app.state.http_session
@@ -215,6 +223,30 @@ def create_app() -> FastAPI:
             raise HTTPException(status_code=404, detail="episode not initialized")
         return session.last_state
 
+    @app.get("/web", response_class=HTMLResponse)
+    @app.get("/web/", response_class=HTMLResponse)
+    async def web_interface() -> str:
+        return _render_web_interface_html()
+
+    @app.get("/web/metadata")
+    async def web_metadata() -> JSONResponse:
+        return JSONResponse(web_metadata_payload)
+
+    @app.post("/web/reset")
+    async def web_reset(payload: ResetRequest | None = None) -> JSONResponse:
+        result = await reset_episode(payload)
+        return JSONResponse(_build_web_step_result(result))
+
+    @app.post("/web/step")
+    async def web_step(payload: dict[str, Any]) -> JSONResponse:
+        result = await step_episode(_parse_web_step_request(payload))
+        return JSONResponse(_build_web_step_result(result))
+
+    @app.get("/web/state")
+    async def web_state() -> JSONResponse:
+        session: HttpSessionState = app.state.http_session
+        return JSONResponse(_build_web_state(session))
+
     @app.get("/tasks")
     async def tasks() -> JSONResponse:
         manager: EpisodeManager = app.state.episode_manager
@@ -323,6 +355,174 @@ def _merge_stderr(stderr: str, extra: str) -> str:
     return f"{stderr.rstrip()}\n{extra}"
 
 
+def _build_web_metadata() -> dict[str, Any]:
+    return {
+        "name": "sysadmin-env",
+        "description": "Shell-based sysadmin environment with OpenEnv-compatible web shim routes.",
+        "readme_content": _load_readme_content(),
+        "documentation_url": "/docs",
+    }
+
+
+def _load_readme_content() -> str | None:
+    readme_path = Path(__file__).resolve().parents[1] / "README.md"
+    try:
+        return readme_path.read_text(encoding="utf-8")
+    except OSError:
+        return None
+
+
+def _build_web_step_result(result: StepResult) -> dict[str, Any]:
+    observation = result.observation.model_dump()
+    return {
+        "observation": observation,
+        "reward": result.observation.reward,
+        "done": result.observation.done,
+        "state": result.state.model_dump(),
+    }
+
+
+def _build_web_state(session: HttpSessionState) -> dict[str, Any]:
+    if session.last_state is None:
+        return {
+            "episode_id": None,
+            "task_id": None,
+            "step_count": 0,
+            "max_steps": 0,
+            "done": False,
+            "reward": 0.0,
+            "initialized": False,
+        }
+
+    payload = session.last_state.model_dump()
+    payload["initialized"] = True
+    return payload
+
+
+def _parse_web_step_request(payload: dict[str, Any]) -> StepRequest:
+    action_payload = payload.get("action", payload)
+    if not isinstance(action_payload, dict):
+        raise HTTPException(status_code=422, detail="action payload must be an object")
+
+    try:
+        action = Action.model_validate(action_payload)
+    except ValidationError as exc:
+        raise HTTPException(status_code=422, detail=exc.errors()) from exc
+
+    return StepRequest(action=action)
+
+
+def _render_web_interface_html() -> str:
+    return """<!doctype html>
+<html lang=\"en\">
+<head>
+  <meta charset=\"utf-8\">
+  <meta name=\"viewport\" content=\"width=device-width, initial-scale=1\">
+  <title>sysadmin-env web shim</title>
+  <style>
+    body { font-family: system-ui, sans-serif; margin: 2rem auto; max-width: 960px; padding: 0 1rem; }
+    h1, h2 { margin-bottom: 0.5rem; }
+    .panel { border: 1px solid #d0d7de; border-radius: 8px; padding: 1rem; margin-bottom: 1rem; }
+    .row { display: flex; gap: 0.75rem; flex-wrap: wrap; margin-bottom: 0.75rem; }
+    input, select, button, textarea { font: inherit; padding: 0.5rem; }
+    input, select, textarea { min-width: 240px; }
+    textarea { width: 100%; min-height: 6rem; }
+    pre { background: #0d1117; color: #e6edf3; padding: 1rem; overflow-x: auto; border-radius: 6px; }
+    code { background: #f6f8fa; padding: 0.1rem 0.3rem; border-radius: 4px; }
+  </style>
+</head>
+<body>
+  <h1>sysadmin-env web compatibility shim</h1>
+  <p>This page exposes the OpenEnv-compatible helper routes for the existing FastAPI environment without changing the primary HTTP or websocket API.</p>
+
+  <div class=\"panel\">
+    <h2>Reset</h2>
+    <div class=\"row\">
+      <select id=\"task-id\"></select>
+      <button id=\"reset-button\" type=\"button\">POST /web/reset</button>
+      <button id=\"state-button\" type=\"button\">GET /web/state</button>
+      <button id=\"metadata-button\" type=\"button\">GET /web/metadata</button>
+    </div>
+  </div>
+
+  <div class=\"panel\">
+    <h2>Step</h2>
+    <div class=\"row\">
+      <input id=\"command\" type=\"text\" placeholder=\"echo hello\">
+      <input id=\"reasoning\" type=\"text\" placeholder=\"optional reasoning\">
+      <button id=\"step-button\" type=\"button\">POST /web/step</button>
+    </div>
+    <p>Route contract: <code>{\"action\": {\"command\": \"...\", \"reasoning\": \"...\"}}</code></p>
+  </div>
+
+  <div class=\"panel\">
+    <h2>Response</h2>
+    <pre id=\"output\">loading tasks...</pre>
+  </div>
+
+  <script>
+    const output = document.getElementById('output');
+    const taskSelect = document.getElementById('task-id');
+
+    async function showResponse(response) {
+      const text = await response.text();
+      try {
+        output.textContent = JSON.stringify(JSON.parse(text), null, 2);
+      } catch {
+        output.textContent = text;
+      }
+    }
+
+    async function loadTasks() {
+      const response = await fetch('/tasks');
+      const payload = await response.json();
+      taskSelect.innerHTML = payload.tasks.map((task) => `<option value="${task.task_id}">${task.task_id}</option>`).join('');
+      output.textContent = JSON.stringify(payload, null, 2);
+    }
+
+    document.getElementById('reset-button').addEventListener('click', async () => {
+      const response = await fetch('/web/reset', {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify({ task_id: taskSelect.value || null }),
+      });
+      await showResponse(response);
+    });
+
+    document.getElementById('step-button').addEventListener('click', async () => {
+      const payload = {
+        action: {
+          command: document.getElementById('command').value,
+          reasoning: document.getElementById('reasoning').value || null,
+        },
+      };
+      const response = await fetch('/web/step', {
+        method: 'POST',
+        headers: { 'Content-Type': 'application/json' },
+        body: JSON.stringify(payload),
+      });
+      await showResponse(response);
+    });
+
+    document.getElementById('state-button').addEventListener('click', async () => {
+      const response = await fetch('/web/state');
+      await showResponse(response);
+    });
+
+    document.getElementById('metadata-button').addEventListener('click', async () => {
+      const response = await fetch('/web/metadata');
+      await showResponse(response);
+    });
+
+    loadTasks().catch((error) => {
+      output.textContent = `Failed to load tasks: ${error.message}`;
+    });
+  </script>
+</body>
+</html>
+"""
+
+
 def _build_environment_state(episode: EpisodeState, episode_id: str, observation: Observation) -> EnvironmentState:
     return EnvironmentState(
         episode_id=episode_id,

tests/test_server.py

@@ -94,6 +94,60 @@ def test_http_step_requires_reset(monkeypatch):
     assert response.status_code == 409
 
 
+def test_web_routes_expose_compatibility_shim_and_delegate_to_current_environment(monkeypatch):
+    client = _make_client(monkeypatch)
+
+    web_response = client.get("/web")
+    assert web_response.status_code == 200
+    assert "sysadmin-env web compatibility shim" in web_response.text
+
+    metadata_response = client.get("/web/metadata")
+    assert metadata_response.status_code == 200
+    metadata_payload = metadata_response.json()
+    assert metadata_payload["name"] == "sysadmin-env"
+    assert "OpenEnv-compatible web shim routes" in metadata_payload["description"]
+
+    pre_reset_state_response = client.get("/web/state")
+    assert pre_reset_state_response.status_code == 200
+    assert pre_reset_state_response.json() == {
+        "episode_id": None,
+        "task_id": None,
+        "step_count": 0,
+        "max_steps": 0,
+        "done": False,
+        "reward": 0.0,
+        "initialized": False,
+    }
+
+    reset_response = client.post("/web/reset", json={"task_id": "nginx_crash"})
+    assert reset_response.status_code == 200
+    reset_payload = reset_response.json()
+    assert reset_payload["state"]["task_id"] == "nginx_crash"
+    assert reset_payload["observation"]["step_number"] == 0
+    assert reset_payload["reward"] == 0.0
+    assert reset_payload["done"] is False
+
+    step_response = client.post("/web/step", json={"action": {"command": "echo hello"}})
+    assert step_response.status_code == 200
+    step_payload = step_response.json()
+    assert step_payload["observation"]["stdout"] == "ran echo hello"
+    assert step_payload["state"]["step_count"] == 1
+    assert step_payload["reward"] == step_payload["observation"]["reward"]
+    assert step_payload["done"] is False
+
+    post_step_state_response = client.get("/web/state")
+    assert post_step_state_response.status_code == 200
+    assert post_step_state_response.json() == {
+        "episode_id": reset_payload["state"]["episode_id"],
+        "task_id": "nginx_crash",
+        "step_count": 1,
+        "max_steps": 40,
+        "done": False,
+        "reward": step_payload["reward"],
+        "initialized": True,
+    }
+
+
 def test_websocket_handles_valid_invalid_and_timeout_actions(monkeypatch):
     client = _make_client(monkeypatch)