digiarena 0.1.0__tar.gz

digiarena-0.1.0/.github/workflows/publish.yml

@@ -0,0 +1,39 @@
+# Publish to PyPI via Trusted Publishing (OIDC — no API token stored anywhere).
+# Trigger: pushing a version tag (v0.1.0). One-time setup on pypi.org required:
+# add this repo+workflow as a "pending publisher" for the `digiarena` project
+# (pypi.org → Your projects → Publishing → GitHub:
+#  owner Grounded-Intelligence-Initiative, repo digiarena-client-python,
+#  workflow publish.yml, environment pypi).
+name: publish
+
+on:
+  push:
+    tags: ["v*"]
+
+jobs:
+  build:
+    runs-on: ubuntu-latest
+    steps:
+      - uses: actions/checkout@v4
+      - uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - run: python -m pip install build
+      - run: python -m build
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment: pypi
+    permissions:
+      id-token: write  # OIDC for trusted publishing
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist/
+      - uses: pypa/gh-action-pypi-publish@release/v1

digiarena-0.1.0/.gitignore

@@ -0,0 +1,5 @@
+__pycache__/
+*.egg-info/
+dist/
+.venv/
+.pytest_cache/

digiarena-0.1.0/LICENSE

@@ -0,0 +1,202 @@
+
+                                 Apache License
+                           Version 2.0, January 2004
+                        http://www.apache.org/licenses/
+
+   TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+
+   1. Definitions.
+
+      "License" shall mean the terms and conditions for use, reproduction,
+      and distribution as defined by Sections 1 through 9 of this document.
+
+      "Licensor" shall mean the copyright owner or entity authorized by
+      the copyright owner that is granting the License.
+
+      "Legal Entity" shall mean the union of the acting entity and all
+      other entities that control, are controlled by, or are under common
+      control with that entity. For the purposes of this definition,
+      "control" means (i) the power, direct or indirect, to cause the
+      direction or management of such entity, whether by contract or
+      otherwise, or (ii) ownership of fifty percent (50%) or more of the
+      outstanding shares, or (iii) beneficial ownership of such entity.
+
+      "You" (or "Your") shall mean an individual or Legal Entity
+      exercising permissions granted by this License.
+
+      "Source" form shall mean the preferred form for making modifications,
+      including but not limited to software source code, documentation
+      source, and configuration files.
+
+      "Object" form shall mean any form resulting from mechanical
+      transformation or translation of a Source form, including but
+      not limited to compiled object code, generated documentation,
+      and conversions to other media types.
+
+      "Work" shall mean the work of authorship, whether in Source or
+      Object form, made available under the License, as indicated by a
+      copyright notice that is included in or attached to the work
+      (an example is provided in the Appendix below).
+
+      "Derivative Works" shall mean any work, whether in Source or Object
+      form, that is based on (or derived from) the Work and for which the
+      editorial revisions, annotations, elaborations, or other modifications
+      represent, as a whole, an original work of authorship. For the purposes
+      of this License, Derivative Works shall not include works that remain
+      separable from, or merely link (or bind by name) to the interfaces of,
+      the Work and Derivative Works thereof.
+
+      "Contribution" shall mean any work of authorship, including
+      the original version of the Work and any modifications or additions
+      to that Work or Derivative Works thereof, that is intentionally
+      submitted to Licensor for inclusion in the Work by the copyright owner
+      or by an individual or Legal Entity authorized to submit on behalf of
+      the copyright owner. For the purposes of this definition, "submitted"
+      means any form of electronic, verbal, or written communication sent
+      to the Licensor or its representatives, including but not limited to
+      communication on electronic mailing lists, source code control systems,
+      and issue tracking systems that are managed by, or on behalf of, the
+      Licensor for the purpose of discussing and improving the Work, but
+      excluding communication that is conspicuously marked or otherwise
+      designated in writing by the copyright owner as "Not a Contribution."
+
+      "Contributor" shall mean Licensor and any individual or Legal Entity
+      on behalf of whom a Contribution has been received by Licensor and
+      subsequently incorporated within the Work.
+
+   2. Grant of Copyright License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      copyright license to reproduce, prepare Derivative Works of,
+      publicly display, publicly perform, sublicense, and distribute the
+      Work and such Derivative Works in Source or Object form.
+
+   3. Grant of Patent License. Subject to the terms and conditions of
+      this License, each Contributor hereby grants to You a perpetual,
+      worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+      (except as stated in this section) patent license to make, have made,
+      use, offer to sell, sell, import, and otherwise transfer the Work,
+      where such license applies only to those patent claims licensable
+      by such Contributor that are necessarily infringed by their
+      Contribution(s) alone or by combination of their Contribution(s)
+      with the Work to which such Contribution(s) was submitted. If You
+      institute patent litigation against any entity (including a
+      cross-claim or counterclaim in a lawsuit) alleging that the Work
+      or a Contribution incorporated within the Work constitutes direct
+      or contributory patent infringement, then any patent licenses
+      granted to You under this License for that Work shall terminate
+      as of the date such litigation is filed.
+
+   4. Redistribution. You may reproduce and distribute copies of the
+      Work or Derivative Works thereof in any medium, with or without
+      modifications, and in Source or Object form, provided that You
+      meet the following conditions:
+
+      (a) You must give any other recipients of the Work or
+          Derivative Works a copy of this License; and
+
+      (b) You must cause any modified files to carry prominent notices
+          stating that You changed the files; and
+
+      (c) You must retain, in the Source form of any Derivative Works
+          that You distribute, all copyright, patent, trademark, and
+          attribution notices from the Source form of the Work,
+          excluding those notices that do not pertain to any part of
+          the Derivative Works; and
+
+      (d) If the Work includes a "NOTICE" text file as part of its
+          distribution, then any Derivative Works that You distribute must
+          include a readable copy of the attribution notices contained
+          within such NOTICE file, excluding those notices that do not
+          pertain to any part of the Derivative Works, in at least one
+          of the following places: within a NOTICE text file distributed
+          as part of the Derivative Works; within the Source form or
+          documentation, if provided along with the Derivative Works; or,
+          within a display generated by the Derivative Works, if and
+          wherever such third-party notices normally appear. The contents
+          of the NOTICE file are for informational purposes only and
+          do not modify the License. You may add Your own attribution
+          notices within Derivative Works that You distribute, alongside
+          or as an addendum to the NOTICE text from the Work, provided
+          that such additional attribution notices cannot be construed
+          as modifying the License.
+
+      You may add Your own copyright statement to Your modifications and
+      may provide additional or different license terms and conditions
+      for use, reproduction, or distribution of Your modifications, or
+      for any such Derivative Works as a whole, provided Your use,
+      reproduction, and distribution of the Work otherwise complies with
+      the conditions stated in this License.
+
+   5. Submission of Contributions. Unless You explicitly state otherwise,
+      any Contribution intentionally submitted for inclusion in the Work
+      by You to the Licensor shall be under the terms and conditions of
+      this License, without any additional terms or conditions.
+      Notwithstanding the above, nothing herein shall supersede or modify
+      the terms of any separate license agreement you may have executed
+      with Licensor regarding such Contributions.
+
+   6. Trademarks. This License does not grant permission to use the trade
+      names, trademarks, service marks, or product names of the Licensor,
+      except as required for reasonable and customary use in describing the
+      origin of the Work and reproducing the content of the NOTICE file.
+
+   7. Disclaimer of Warranty. Unless required by applicable law or
+      agreed to in writing, Licensor provides the Work (and each
+      Contributor provides its Contributions) on an "AS IS" BASIS,
+      WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+      implied, including, without limitation, any warranties or conditions
+      of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+      PARTICULAR PURPOSE. You are solely responsible for determining the
+      appropriateness of using or redistributing the Work and assume any
+      risks associated with Your exercise of permissions under this License.
+
+   8. Limitation of Liability. In no event and under no legal theory,
+      whether in tort (including negligence), contract, or otherwise,
+      unless required by applicable law (such as deliberate and grossly
+      negligent acts) or agreed to in writing, shall any Contributor be
+      liable to You for damages, including any direct, indirect, special,
+      incidental, or consequential damages of any character arising as a
+      result of this License or out of the use or inability to use the
+      Work (including but not limited to damages for loss of goodwill,
+      work stoppage, computer failure or malfunction, or any and all
+      other commercial damages or losses), even if such Contributor
+      has been advised of the possibility of such damages.
+
+   9. Accepting Warranty or Additional Liability. While redistributing
+      the Work or Derivative Works thereof, You may choose to offer,
+      and charge a fee for, acceptance of support, warranty, indemnity,
+      or other liability obligations and/or rights consistent with this
+      License. However, in accepting such obligations, You may act only
+      on Your own behalf and on Your sole responsibility, not on behalf
+      of any other Contributor, and only if You agree to indemnify,
+      defend, and hold each Contributor harmless for any liability
+      incurred by, or claims asserted against, such Contributor by reason
+      of your accepting any such warranty or additional liability.
+
+   END OF TERMS AND CONDITIONS
+
+   APPENDIX: How to apply the Apache License to your work.
+
+      To apply the Apache License to your work, attach the following
+      boilerplate notice, with the fields enclosed by brackets "[]"
+      replaced with your own identifying information. (Don't include
+      the brackets!)  The text should be enclosed in the appropriate
+      comment syntax for the file format. We also recommend that a
+      file or class name and description of purpose be included on the
+      same "printed page" as the copyright notice for easier
+      identification within third-party archives.
+
+   Copyright [yyyy] [name of copyright owner]
+
+   Licensed under the Apache License, Version 2.0 (the "License");
+   you may not use this file except in compliance with the License.
+   You may obtain a copy of the License at
+
+       http://www.apache.org/licenses/LICENSE-2.0
+
+   Unless required by applicable law or agreed to in writing, software
+   distributed under the License is distributed on an "AS IS" BASIS,
+   WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+   See the License for the specific language governing permissions and
+   limitations under the License.

digiarena-0.1.0/PKG-INFO

@@ -0,0 +1,81 @@
+Metadata-Version: 2.4
+Name: digiarena
+Version: 0.1.0
+Summary: Python SDK for DigiArena (digiarena.org): browse hosted robot-simulation scenes, deploy cloud gyms, submit to benchmarks.
+Project-URL: Homepage, https://digiarena.org
+Project-URL: Repository, https://github.com/Grounded-Intelligence-Initiative/digiarena-client-python
+Project-URL: Documentation, https://digiarena.org/docs/api
+Author-email: Xiatao Sun <sunxiatao@gmail.com>
+License: Apache-2.0
+License-File: LICENSE
+Keywords: benchmark,gaussian-splatting,gymnasium,real2sim,robotics,simulation
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Science/Research
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Topic :: Scientific/Engineering :: Artificial Intelligence
+Requires-Python: >=3.10
+Requires-Dist: world-engine-client>=0.2
+Description-Content-Type: text/markdown
+
+# digiarena (PyPI: `digiarena`)
+
+Python SDK for [DigiArena](https://digiarena.org) — browse hosted
+robot-simulation scenes, deploy them as cloud gyms, and submit to benchmarks.
+
+```bash
+pip install digiarena
+```
+
+```python
+import digiarena as da
+
+da.login()                                   # paste an API key from digiarena.org → Settings
+scenes = da.scenes.list(query="kitchen")
+gym = da.deploy(scene="kitchen_001", task="pick_mug_to_sink")
+env = gym.connect()                          # → world_engine_client.RemoteEnv
+obs, info = env.reset(seed=0)
+obs, r, term, trunc, info = env.step(action)
+gym.close()
+```
+
+CLI with the same surface:
+
+```
+digiarena login
+digiarena scenes list --query kitchen
+digiarena deploy --scene kitchen_001
+digiarena leaderboard tabletop-v1
+digiarena usage
+```
+
+## Layering
+
+`digiarena` depends on and reuses
+[`world-engine-client`](https://github.com/Grounded-Intelligence-Initiative/world-engine-client-python)
+(`connect(token, url) → RemoteEnv`). This package covers everything from your
+account to that token — scene gallery, cloud deploy, benchmark submission,
+leaderboards, usage — and never reimplements the wire protocol.
+
+- Zero heavy dependencies: importing `digiarena` pulls stdlib + numpy only
+  (via `world-engine-client`). No torch / gymnasium / opencv.
+- Every call hits the public REST API (`/api/v1/*`) with
+  `Authorization: Bearer da_live_...` — the SDK is a thin wrapper you could
+  replace with curl.
+- Typed errors with actionable "Possible fixes" (the World Engine style).
+- Endpoints still in later platform milestones (deploy orchestration,
+  benchmark submission) raise `NotImplementedYetError` with the server's own
+  guidance — the SDK surface is stable ahead of them.
+
+Scene content never transits your machine: there is no upload()/download().
+Content is authored in the platform's browser editor; public scenes are used
+via `scene.fork()` + `da.deploy()`.
+
+## Credentials
+
+`DIGIARENA_API_KEY` env var (CI/batch) → `~/.config/digiarena/credentials`
+(written by `da.login()` / `digiarena login`, mode 0600).
+`DIGIARENA_API_URL` overrides the endpoint for staging deployments.

digiarena-0.1.0/README.md

@@ -0,0 +1,58 @@
+# digiarena (PyPI: `digiarena`)
+
+Python SDK for [DigiArena](https://digiarena.org) — browse hosted
+robot-simulation scenes, deploy them as cloud gyms, and submit to benchmarks.
+
+```bash
+pip install digiarena
+```
+
+```python
+import digiarena as da
+
+da.login()                                   # paste an API key from digiarena.org → Settings
+scenes = da.scenes.list(query="kitchen")
+gym = da.deploy(scene="kitchen_001", task="pick_mug_to_sink")
+env = gym.connect()                          # → world_engine_client.RemoteEnv
+obs, info = env.reset(seed=0)
+obs, r, term, trunc, info = env.step(action)
+gym.close()
+```
+
+CLI with the same surface:
+
+```
+digiarena login
+digiarena scenes list --query kitchen
+digiarena deploy --scene kitchen_001
+digiarena leaderboard tabletop-v1
+digiarena usage
+```
+
+## Layering
+
+`digiarena` depends on and reuses
+[`world-engine-client`](https://github.com/Grounded-Intelligence-Initiative/world-engine-client-python)
+(`connect(token, url) → RemoteEnv`). This package covers everything from your
+account to that token — scene gallery, cloud deploy, benchmark submission,
+leaderboards, usage — and never reimplements the wire protocol.
+
+- Zero heavy dependencies: importing `digiarena` pulls stdlib + numpy only
+  (via `world-engine-client`). No torch / gymnasium / opencv.
+- Every call hits the public REST API (`/api/v1/*`) with
+  `Authorization: Bearer da_live_...` — the SDK is a thin wrapper you could
+  replace with curl.
+- Typed errors with actionable "Possible fixes" (the World Engine style).
+- Endpoints still in later platform milestones (deploy orchestration,
+  benchmark submission) raise `NotImplementedYetError` with the server's own
+  guidance — the SDK surface is stable ahead of them.
+
+Scene content never transits your machine: there is no upload()/download().
+Content is authored in the platform's browser editor; public scenes are used
+via `scene.fork()` + `da.deploy()`.
+
+## Credentials
+
+`DIGIARENA_API_KEY` env var (CI/batch) → `~/.config/digiarena/credentials`
+(written by `da.login()` / `digiarena login`, mode 0600).
+`DIGIARENA_API_URL` overrides the endpoint for staging deployments.

digiarena-0.1.0/pyproject.toml

@@ -0,0 +1,48 @@
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[project]
+name = "digiarena"
+version = "0.1.0"
+description = "Python SDK for DigiArena (digiarena.org): browse hosted robot-simulation scenes, deploy cloud gyms, submit to benchmarks."
+readme = "README.md"
+requires-python = ">=3.10"
+license = { text = "Apache-2.0" }
+authors = [{ name = "Xiatao Sun", email = "sunxiatao@gmail.com" }]
+keywords = ["robotics", "simulation", "benchmark", "gymnasium", "gaussian-splatting", "real2sim"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Science/Research",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Topic :: Scientific/Engineering :: Artificial Intelligence",
+]
+# 分层原则（07 文档）：digiarena 只封装「从账号到 token+URL」，wire 协议
+# 全部复用 world-engine-client；HTTP 走 stdlib urllib——零额外依赖。
+dependencies = [
+    "world-engine-client>=0.2",
+]
+
+[project.scripts]
+digiarena = "digiarena.cli:main"
+
+[project.urls]
+Homepage = "https://digiarena.org"
+Repository = "https://github.com/Grounded-Intelligence-Initiative/digiarena-client-python"
+Documentation = "https://digiarena.org/docs/api"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/digiarena"]
+
+[tool.ruff]
+line-length = 100
+
+[tool.ruff.lint]
+select = ["E", "F", "I", "B", "UP", "W"]
+
+[dependency-groups]
+dev = ["pytest>=8"]

digiarena-0.1.0/src/digiarena/__init__.py

@@ -0,0 +1,64 @@
+"""digiarena — the DigiArena platform SDK (PyPI: ``digiarena``).
+
+    import digiarena as da
+
+    da.login()                      # paste an API key from digiarena.org → Settings
+    scenes = da.scenes.list(query="kitchen")
+    gym = da.deploy(scene="kitchen_001", task="pick_mug_to_sink")
+    env = gym.connect()             # → world_engine_client.RemoteEnv
+    obs, info = env.reset(seed=0)
+    obs, r, term, trunc, info = env.step(action)
+    gym.close()
+
+Layering: ``world-engine-client`` turns token+URL into a Gym env (the wire
+protocol); ``digiarena`` covers everything from your account to that token —
+scene gallery, cloud deploy, benchmarks, leaderboard, usage. Importing this
+package never pulls heavy dependencies (no torch / gymnasium / opencv).
+"""
+
+from __future__ import annotations
+
+__version__ = "0.1.0"
+
+from . import benchmarks, scenes  # noqa: E402  (submodule namespaces)
+from .config import login  # noqa: E402
+from .errors import (  # noqa: E402
+    ApiError,
+    AuthError,
+    DeployTimeoutError,
+    DigiArenaError,
+    NotImplementedYetError,
+    QuotaExceededError,
+    RateLimitedError,
+    SceneExistsError,
+    SceneNotFoundError,
+)
+from .gyms import GymHandle, deploy, list_gyms  # noqa: E402
+from .usage import usage  # noqa: E402
+
+
+def leaderboard(benchmark: str):
+    """Shortcut for :func:`digiarena.benchmarks.leaderboard`."""
+    return benchmarks.leaderboard(benchmark)
+
+
+__all__ = [
+    "__version__",
+    "login",
+    "deploy",
+    "list_gyms",
+    "leaderboard",
+    "usage",
+    "GymHandle",
+    "scenes",
+    "benchmarks",
+    "DigiArenaError",
+    "AuthError",
+    "RateLimitedError",
+    "SceneNotFoundError",
+    "SceneExistsError",
+    "QuotaExceededError",
+    "DeployTimeoutError",
+    "NotImplementedYetError",
+    "ApiError",
+]

digiarena-0.1.0/src/digiarena/_http.py

@@ -0,0 +1,82 @@
+"""Minimal stdlib HTTP layer for the DigiArena control plane.
+
+Every call goes to the public REST API (``/api/v1/*``) with
+``Authorization: Bearer da_live_...`` — the SDK is a thin wrapper anyone could
+replace with curl. stdlib ``urllib`` only (zero-dependency principle).
+"""
+
+from __future__ import annotations
+
+import json
+import urllib.error
+import urllib.parse
+import urllib.request
+
+from . import __version__ as _sdk_version
+from .config import api_base, api_key
+from .errors import ApiError, AuthError, raise_for
+
+_TIMEOUT_S = 30.0
+
+
+def request(
+    method: str,
+    path: str,
+    *,
+    query: dict[str, str] | None = None,
+    body: dict | None = None,
+    auth: bool = True,
+) -> dict:
+    """One control-plane call → parsed ``{ok:true, ...}`` payload.
+
+    ``{ok:false}`` replies raise the typed exception for their code; transport
+    failures raise :class:`ApiError` with the underlying reason.
+    """
+    url = api_base().rstrip("/") + path
+    if query:
+        url += "?" + urllib.parse.urlencode({k: v for k, v in query.items() if v is not None})
+    headers = {
+        "User-Agent": f"digiarena-python/{_sdk_version}",
+        "Accept": "application/json",
+    }
+    if auth:
+        key = api_key()
+        if not key:
+            raise AuthError(
+                "No API key configured.",
+                code="unauthorized",
+                fixes=[
+                    "Run `digiarena login` (or da.login()) and paste a key from "
+                    "digiarena.org → Settings",
+                    "Or set the DIGIARENA_API_KEY environment variable",
+                ],
+            )
+        headers["Authorization"] = f"Bearer {key}"
+    data = None
+    if body is not None:
+        data = json.dumps(body).encode("utf-8")
+        headers["Content-Type"] = "application/json"
+
+    req = urllib.request.Request(url, data=data, headers=headers, method=method)
+    try:
+        with urllib.request.urlopen(req, timeout=_TIMEOUT_S) as resp:
+            payload = json.loads(resp.read().decode("utf-8"))
+    except urllib.error.HTTPError as e:
+        try:
+            payload = json.loads(e.read().decode("utf-8"))
+        except Exception:
+            raise ApiError(f"HTTP {e.code} from {path}", status=e.code) from e
+        raise_for(e.code, payload)
+        raise AssertionError("unreachable") from None  # raise_for always raises
+    except urllib.error.URLError as e:
+        raise ApiError(
+            f"Cannot reach the DigiArena API at {api_base()}: {e.reason}",
+            fixes=[
+                "Check your network connection",
+                "Override the endpoint with DIGIARENA_API_URL if you are "
+                "targeting a staging deployment",
+            ],
+        ) from e
+    if not payload.get("ok", False):
+        raise_for(200, payload)
+    return payload

digiarena-0.1.0/src/digiarena/benchmarks.py

@@ -0,0 +1,38 @@
+"""Benchmarks: list / leaderboard / submissions.
+
+Benchmark ids are ``{slug}-v{version}`` — the protocol (episode count, seed
+rules, max_steps) is frozen per version so leaderboard scores stay comparable.
+Submission endpoints are part of a later milestone; the SDK surface is final.
+"""
+
+from __future__ import annotations
+
+from typing import Any
+
+from ._http import request
+
+
+def list() -> list[dict[str, Any]]:  # noqa: A001 - mirrors da.benchmarks.list()
+    """Published benchmarks (public, no key needed)."""
+    return request("GET", "/api/v1/benchmarks", auth=False)["benchmarks"]
+
+
+def leaderboard(benchmark: str) -> list[dict[str, Any]]:
+    """The public leaderboard of one benchmark (pandas-free list of dicts)."""
+    return request("GET", f"/api/v1/benchmarks/{benchmark}/leaderboard", auth=False)[
+        "leaderboard"
+    ]
+
+
+def submit_live(benchmark: str, *, entry_name: str) -> dict[str, Any]:
+    """Create a live-client submission (your policy runs on your machine)."""
+    return request(
+        "POST",
+        f"/api/v1/benchmarks/{benchmark}/submissions",
+        body={"mode": "live", "entry_name": entry_name},
+    )
+
+
+def submission(benchmark: str, submission_id: str) -> dict[str, Any]:
+    """Progress/result of one submission."""
+    return request("GET", f"/api/v1/benchmarks/{benchmark}/submissions/{submission_id}")

digiarena-0.1.0/src/digiarena/cli.py

@@ -0,0 +1,120 @@
+"""``digiarena`` CLI — the same surface as the SDK, for shells and CI.
+
+    digiarena login
+    digiarena scenes list [--query q] [--mine]
+    digiarena scenes get <owner/slug>
+    digiarena scenes create <slug> [--name n] [--public]
+    digiarena deploy --scene <owner/slug> [--task t]
+    digiarena gyms list / close <id> / logs <id>
+    digiarena benchmarks list
+    digiarena leaderboard <benchmark>
+    digiarena usage
+"""
+
+from __future__ import annotations
+
+import argparse
+import json
+import sys
+
+
+def _print(obj: object) -> None:
+    print(json.dumps(obj, indent=2, ensure_ascii=False, default=str))
+
+
+def main(argv: list[str] | None = None) -> int:
+    parser = argparse.ArgumentParser(
+        prog="digiarena", description="DigiArena platform CLI (digiarena.org)"
+    )
+    sub = parser.add_subparsers(dest="cmd", required=True)
+
+    sub.add_parser("login", help="store an API key for subsequent calls")
+
+    p_scenes = sub.add_parser("scenes", help="scene gallery")
+    scenes_sub = p_scenes.add_subparsers(dest="scenes_cmd", required=True)
+    p_list = scenes_sub.add_parser("list")
+    p_list.add_argument("--query")
+    p_list.add_argument("--mine", action="store_true", help="your scenes (needs the API key)")
+    p_get = scenes_sub.add_parser("get")
+    p_get.add_argument("scene_id", metavar="owner/slug")
+    p_create = scenes_sub.add_parser("create")
+    p_create.add_argument("slug")
+    p_create.add_argument("--name")
+    p_create.add_argument("--description", default="")
+    p_create.add_argument("--public", action="store_true")
+
+    p_deploy = sub.add_parser("deploy", help="deploy a scene as a cloud gym")
+    p_deploy.add_argument("--scene", required=True)
+    p_deploy.add_argument("--task")
+    p_deploy.add_argument("--tier", default="auto")
+
+    p_gyms = sub.add_parser("gyms", help="your gym sessions")
+    gyms_sub = p_gyms.add_subparsers(dest="gyms_cmd", required=True)
+    gyms_sub.add_parser("list")
+    p_close = gyms_sub.add_parser("close")
+    p_close.add_argument("gym_id")
+    p_logs = gyms_sub.add_parser("logs")
+    p_logs.add_argument("gym_id")
+    p_logs.add_argument("--tail", type=int, default=100)
+
+    p_bm = sub.add_parser("benchmarks", help="published benchmarks")
+    bm_sub = p_bm.add_subparsers(dest="bm_cmd", required=True)
+    bm_sub.add_parser("list")
+
+    p_lb = sub.add_parser("leaderboard")
+    p_lb.add_argument("benchmark", metavar="slug-vN")
+
+    sub.add_parser("usage", help="this month's quota/usage")
+
+    args = parser.parse_args(argv)
+
+    import digiarena as da
+
+    try:
+        if args.cmd == "login":
+            da.login()
+        elif args.cmd == "scenes":
+            if args.scenes_cmd == "list":
+                _print([s.__dict__ for s in da.scenes.list(args.query, public=not args.mine)])
+            elif args.scenes_cmd == "get":
+                _print(da.scenes.get(args.scene_id).__dict__)
+            elif args.scenes_cmd == "create":
+                _print(
+                    da.scenes.create(
+                        args.slug,
+                        name=args.name,
+                        description=args.description,
+                        public=args.public,
+                    ).__dict__
+                )
+        elif args.cmd == "deploy":
+            gym = da.deploy(args.scene, task=args.task, tier=args.tier)
+            _print(gym.__dict__)
+            print(
+                "\n# connect once ready:\n"
+                "import digiarena as da\n"
+                'env = da.list_gyms()[0].connect()  # or keep the GymHandle from deploy',
+                file=sys.stderr,
+            )
+        elif args.cmd == "gyms":
+            if args.gyms_cmd == "list":
+                _print([g.__dict__ for g in da.list_gyms()])
+            elif args.gyms_cmd == "close":
+                da.GymHandle(gym_id=args.gym_id, status="ready").close()
+                print("closed")
+            elif args.gyms_cmd == "logs":
+                print(da.GymHandle(gym_id=args.gym_id, status="ready").logs(tail=args.tail))
+        elif args.cmd == "benchmarks":
+            _print(da.benchmarks.list())
+        elif args.cmd == "leaderboard":
+            _print(da.leaderboard(args.benchmark))
+        elif args.cmd == "usage":
+            _print(da.usage())
+    except da.DigiArenaError as e:
+        print(f"error: {e}", file=sys.stderr)
+        return 1
+    return 0
+
+
+if __name__ == "__main__":
+    raise SystemExit(main())

digiarena-0.1.0/src/digiarena/config.py

@@ -0,0 +1,78 @@
+"""Credentials + endpoint resolution.
+
+Precedence (CI/batch first): ``DIGIARENA_API_KEY`` env var →
+``~/.config/digiarena/credentials`` (INI-less ``key = value`` lines, 0600).
+The endpoint defaults to production; ``DIGIARENA_API_URL`` overrides for
+staging/local development.
+"""
+
+from __future__ import annotations
+
+import os
+from pathlib import Path
+
+DEFAULT_API_URL = "https://digiarena.org"
+
+_CRED_DIR = Path(os.environ.get("XDG_CONFIG_HOME", Path.home() / ".config")) / "digiarena"
+_CRED_FILE = _CRED_DIR / "credentials"
+
+
+def api_base() -> str:
+    return os.environ.get("DIGIARENA_API_URL", DEFAULT_API_URL)
+
+
+def _read_credentials() -> dict[str, str]:
+    if not _CRED_FILE.is_file():
+        return {}
+    out: dict[str, str] = {}
+    for line in _CRED_FILE.read_text().splitlines():
+        line = line.strip()
+        if not line or line.startswith("#") or "=" not in line:
+            continue
+        k, v = line.split("=", 1)
+        out[k.strip()] = v.strip()
+    return out
+
+
+def api_key() -> str | None:
+    env = os.environ.get("DIGIARENA_API_KEY")
+    if env:
+        return env
+    return _read_credentials().get("api_key")
+
+
+def save_api_key(key: str) -> Path:
+    """Persist the key to the credentials file (0600). Returns the path."""
+    _CRED_DIR.mkdir(parents=True, exist_ok=True)
+    creds = _read_credentials()
+    creds["api_key"] = key
+    _CRED_FILE.write_text("".join(f"{k} = {v}\n" for k, v in creds.items()))
+    _CRED_FILE.chmod(0o600)
+    return _CRED_FILE
+
+
+def login(key: str | None = None) -> None:
+    """Store an API key for subsequent calls.
+
+    Interactive: called with no argument, prompts for the key (create one on
+    digiarena.org → Settings). Non-interactive callers pass ``key=`` directly
+    or set ``DIGIARENA_API_KEY``.
+    """
+    if key is None:
+        try:
+            key = input("Paste your DigiArena API key (da_live_...): ").strip()
+        except EOFError:  # non-interactive shells
+            key = ""
+    if not key:
+        from .errors import AuthError
+
+        raise AuthError(
+            "No API key provided.",
+            code="unauthorized",
+            fixes=[
+                "Create a key on digiarena.org → Settings",
+                "Or set the DIGIARENA_API_KEY environment variable",
+            ],
+        )
+    path = save_api_key(key)
+    print(f"API key saved to {path}")

digiarena-0.1.0/src/digiarena/errors.py

@@ -0,0 +1,85 @@
+"""Typed errors mirroring the DigiArena control-plane error contract.
+
+Every ``/api/v1/*`` error reply carries ``{ok:false, code, error, fixes:[...]}``;
+:func:`raise_for` maps the code to a typed exception and renders the fixes into
+the message the same way the World Engine CLI does ("Possible fixes:" block).
+"""
+
+from __future__ import annotations
+
+
+class DigiArenaError(RuntimeError):
+    """Base error; carries the server error code + HTTP status when present."""
+
+    def __init__(
+        self,
+        message: str,
+        *,
+        code: str | None = None,
+        status: int | None = None,
+        fixes: list[str] | None = None,
+    ):
+        if fixes:
+            message += "\n  Possible fixes:\n" + "\n".join(
+                f"    {i + 1}. {f}" for i, f in enumerate(fixes)
+            )
+        super().__init__(message)
+        self.code = code
+        self.status = status
+
+
+class AuthError(DigiArenaError):
+    """Missing/invalid API key. Create one on digiarena.org → Settings, then
+    ``da.login()`` (or set the DIGIARENA_API_KEY environment variable)."""
+
+
+class RateLimitedError(DigiArenaError):
+    """The API key hit its rate limit — retry with exponential backoff."""
+
+
+class SceneNotFoundError(DigiArenaError):
+    """The scene id does not exist or is not visible to this account."""
+
+
+class SceneExistsError(DigiArenaError):
+    """A scene with this slug already exists in your namespace."""
+
+
+class QuotaExceededError(DigiArenaError):
+    """The account's compute quota or concurrent-session limit is exhausted."""
+
+
+class DeployTimeoutError(DigiArenaError):
+    """The gym did not reach ready state within the polling window."""
+
+
+class NotImplementedYetError(DigiArenaError):
+    """The endpoint is part of a later milestone (HTTP 501). The SDK surface
+    is stable; retry after the platform ships the feature."""
+
+
+class ApiError(DigiArenaError):
+    """Any other structured control-plane error."""
+
+
+_BY_CODE: dict[str, type[DigiArenaError]] = {
+    "unauthorized": AuthError,
+    "rate_limited": RateLimitedError,
+    "scene_not_found": SceneNotFoundError,
+    "scene_exists": SceneExistsError,
+    "quota_exceeded": QuotaExceededError,
+    "session_limit": QuotaExceededError,
+    "not_implemented": NotImplementedYetError,
+}
+
+
+def raise_for(status: int, payload: dict) -> None:
+    """Raise the typed exception for an ``{ok:false, ...}`` reply."""
+    code = payload.get("code")
+    cls = _BY_CODE.get(code or "", ApiError)
+    raise cls(
+        str(payload.get("error") or f"HTTP {status}"),
+        code=code,
+        status=status,
+        fixes=list(payload.get("fixes") or []),
+    )

digiarena-0.1.0/src/digiarena/gyms.py

@@ -0,0 +1,114 @@
+"""Cloud gym deploy: ``da.deploy(...)`` → :class:`GymHandle` → ``connect()``.
+
+The deploy endpoint is part of the orchestration milestone; until the platform
+ships it, ``deploy()`` raises :class:`~digiarena.errors.NotImplementedYetError`
+with the server's own guidance — the SDK surface is final either way.
+"""
+
+from __future__ import annotations
+
+import time
+from dataclasses import dataclass, field
+from typing import Any
+
+from ._http import request
+from .errors import DeployTimeoutError
+
+_POLL_TIMEOUT_S = 300.0
+_POLL_BASE_S = 1.0
+_POLL_MAX_S = 8.0
+
+
+@dataclass
+class GymHandle:
+    """A deployed (or deploying) cloud gym session."""
+
+    gym_id: str
+    status: str  # provisioning | ready | idle | terminated
+    url: str | None = None
+    viewer_url: str | None = None
+    control_token: str | None = field(default=None, repr=False)
+    expires_at: str | None = None
+
+    @staticmethod
+    def _from_api(d: dict[str, Any]) -> GymHandle:
+        return GymHandle(
+            gym_id=d["gym_id"],
+            status=d.get("status", "provisioning"),
+            url=d.get("url"),
+            viewer_url=d.get("viewer_url"),
+            control_token=d.get("control_token"),
+            expires_at=d.get("expires_at"),
+        )
+
+    def refresh(self) -> GymHandle:
+        payload = request("GET", f"/api/v1/gyms/{self.gym_id}")
+        fresh = GymHandle._from_api(payload["gym"])
+        self.__dict__.update(fresh.__dict__)
+        return self
+
+    def wait_ready(self, timeout: float = _POLL_TIMEOUT_S) -> GymHandle:
+        """Poll until ready (exponential backoff), or raise DeployTimeoutError."""
+        deadline = time.monotonic() + timeout
+        delay = _POLL_BASE_S
+        while self.status != "ready":
+            if time.monotonic() > deadline:
+                raise DeployTimeoutError(
+                    f"gym {self.gym_id} not ready after {timeout:.0f}s "
+                    f"(status: {self.status})",
+                    fixes=[
+                        "gym.refresh() later — provisioning may still finish",
+                        "gym.logs() shows the session process output",
+                        "gym.close() releases the slot if you are giving up",
+                    ],
+                )
+            time.sleep(delay)
+            delay = min(delay * 1.7, _POLL_MAX_S)
+            self.refresh()
+        return self
+
+    def connect(self, **kw):
+        """→ ``world_engine_client.RemoteEnv`` driving this gym."""
+        self.wait_ready()
+        import world_engine_client as we_client
+
+        return we_client.connect(self.control_token, url=self.url, **kw)
+
+    def extend(self, minutes: int) -> None:
+        request("POST", f"/api/v1/gyms/{self.gym_id}/extend", body={"minutes": minutes})
+
+    def logs(self, tail: int = 100) -> str:
+        payload = request("GET", f"/api/v1/gyms/{self.gym_id}/logs", query={"tail": str(tail)})
+        return payload.get("logs", "")
+
+    def close(self) -> None:
+        request("DELETE", f"/api/v1/gyms/{self.gym_id}")
+        self.status = "terminated"
+
+    def __enter__(self) -> GymHandle:
+        return self
+
+    def __exit__(self, *exc: object) -> None:
+        self.close()
+
+
+def deploy(
+    scene: str,
+    *,
+    task: str | None = None,
+    tier: str = "auto",
+    region: str | None = None,
+) -> GymHandle:
+    """Deploy a scene as a cloud gym session and return its handle."""
+    payload = request(
+        "POST",
+        "/api/v1/gyms",
+        body={"scene_id": scene, "task_id": task, "tier": tier, "region": region},
+    )
+    return GymHandle._from_api(payload["gym"])
+
+
+def list_gyms() -> list[GymHandle]:
+    """Your active gym sessions."""
+    payload = request("GET", "/api/v1/gyms")
+    return [GymHandle._from_api(g) for g in payload.get("gyms", [])]

digiarena-0.1.0/src/digiarena/scenes.py

@@ -0,0 +1,88 @@
+"""Scene gallery: list / get / create / fork.
+
+Scene ids are namespaced ``{owner}/{slug}`` (owner is the stable account
+UUID). There is deliberately no upload()/download() — scene content never
+transits the user's machine (product decision 2026-08-02); content is authored
+in the platform-hosted browser editor, and public scenes are used via
+``fork()`` + ``deploy()``.
+"""
+
+from __future__ import annotations
+
+from dataclasses import dataclass
+from typing import Any
+
+from ._http import request
+
+
+@dataclass(frozen=True)
+class Scene:
+    """One gallery entry (the ``/api/v1/scenes`` wire shape, typed)."""
+
+    id: str  # "{owner}/{slug}"
+    owner: str
+    owner_name: str | None
+    slug: str
+    name: str
+    description: str
+    public: bool
+    created_at: str
+    updated_at: str
+
+    @staticmethod
+    def _from_api(d: dict[str, Any]) -> Scene:
+        return Scene(
+            id=d["id"],
+            owner=d["owner"],
+            owner_name=d.get("owner_name"),
+            slug=d["slug"],
+            name=d["name"],
+            description=d.get("description", ""),
+            public=bool(d.get("public", False)),
+            created_at=d.get("created_at", ""),
+            updated_at=d.get("updated_at", ""),
+        )
+
+    def fork(self) -> Scene:
+        """Copy this scene into your own namespace (platform-side copy)."""
+        owner, slug = self.id.split("/", 1)
+        payload = request("POST", f"/api/v1/scenes/{owner}/{slug}/fork")
+        return Scene._from_api(payload["scene"])
+
+
+def list(  # noqa: A001 - mirrors the documented da.scenes.list() surface
+    query: str | None = None,
+    *,
+    public: bool = True,
+) -> list[Scene]:
+    """Search scenes. ``public=False`` lists YOUR scenes (needs an API key)."""
+    payload = request(
+        "GET",
+        "/api/v1/scenes",
+        query={"query": query, "public": "false" if not public else None},
+        auth=not public,
+    )
+    return [Scene._from_api(s) for s in payload["scenes"]]
+
+
+def get(scene_id: str) -> Scene:
+    """Fetch one scene by ``{owner}/{slug}``. Private scenes need your key."""
+    owner, _, slug = scene_id.partition("/")
+    from .config import api_key
+
+    payload = request(
+        "GET", f"/api/v1/scenes/{owner}/{slug}", auth=api_key() is not None
+    )
+    return Scene._from_api(payload["scene"])
+
+
+def create(
+    slug: str, *, name: str | None = None, description: str = "", public: bool = False
+) -> Scene:
+    """Create scene METADATA (content is authored in the browser editor)."""
+    payload = request(
+        "POST",
+        "/api/v1/scenes",
+        body={"slug": slug, "name": name or slug, "description": description, "public": public},
+    )
+    return Scene._from_api(payload["scene"])

digiarena-0.1.0/src/digiarena/usage.py

@@ -0,0 +1,12 @@
+"""Account usage / quota."""
+
+from __future__ import annotations
+
+from typing import Any
+
+from ._http import request
+
+
+def usage() -> dict[str, Any]:
+    """This month's compute usage + quota for your account."""
+    return request("GET", "/api/v1/usage")["usage"]

digiarena-0.1.0/tests/test_sdk.py

@@ -0,0 +1,164 @@
+"""SDK contract tests against a local stub control plane (stdlib only).
+
+The stub speaks the frozen /api/v1 wire shapes (07 文档 §4): {ok:true,...} /
+{ok:false, code, error, fixes:[]}. These tests pin the SDK's request shapes,
+auth header, error mapping, and credential resolution — no real platform needed.
+"""
+
+from __future__ import annotations
+
+import json
+import threading
+from http.server import BaseHTTPRequestHandler, HTTPServer
+
+import pytest
+
+import digiarena as da
+from digiarena import errors
+
+KEY = "da_live_test123"
+
+
+class _Stub(BaseHTTPRequestHandler):
+    calls: list[tuple[str, str, dict | None, str | None]] = []
+
+    def _reply(self, status: int, payload: dict) -> None:
+        body = json.dumps(payload).encode()
+        self.send_response(status)
+        self.send_header("Content-Type", "application/json")
+        self.send_header("Content-Length", str(len(body)))
+        self.end_headers()
+        self.wfile.write(body)
+
+    def _record(self) -> tuple[dict | None, str | None]:
+        length = int(self.headers.get("Content-Length") or 0)
+        body = json.loads(self.rfile.read(length)) if length else None
+        auth = self.headers.get("Authorization")
+        _Stub.calls.append((self.command, self.path, body, auth))
+        return body, auth
+
+    def do_GET(self):  # noqa: N802
+        _, auth = self._record()
+        path = self.path.split("?")[0]
+        if path == "/api/v1/benchmarks":
+            self._reply(200, {"ok": True, "benchmarks": [{"id": "tabletop-v1"}]})
+        elif path == "/api/v1/usage":
+            if auth != f"Bearer {KEY}":
+                self._reply(401, {"ok": False, "code": "unauthorized",
+                                  "error": "bad key", "fixes": ["create a key"]})
+            else:
+                self._reply(200, {"ok": True, "usage": {"sim_minutes_used": 0}})
+        elif path.startswith("/api/v1/scenes/"):
+            self._reply(200, {"ok": True, "scene": _SCENE})
+        elif path == "/api/v1/scenes":
+            self._reply(200, {"ok": True, "scenes": [_SCENE]})
+        elif path.startswith("/api/v1/gyms/"):
+            self._reply(200, {"ok": True, "gym": {"gym_id": "g1", "status": "ready",
+                                                  "url": "http://x", "control_token": "t"}})
+        else:
+            self._reply(404, {"ok": False, "code": "not_found", "error": path, "fixes": []})
+
+    def do_POST(self):  # noqa: N802
+        self._record()
+        path = self.path.split("?")[0]
+        if path == "/api/v1/gyms":
+            self._reply(501, {"ok": False, "code": "not_implemented",
+                              "error": "gym deploy 尚未开放",
+                              "fixes": ["该端点属于后续 milestone"]})
+        elif path == "/api/v1/scenes":
+            self._reply(200, {"ok": True, "scene": _SCENE})
+        else:
+            self._reply(404, {"ok": False, "code": "not_found", "error": path, "fixes": []})
+
+    def log_message(self, *a):  # silence
+        pass
+
+
+_SCENE = {
+    "id": "u1/kitchen_001", "owner": "u1", "owner_name": "alice",
+    "slug": "kitchen_001", "name": "Kitchen 001", "description": "",
+    "public": True, "created_at": "2026-01-01T00:00:00Z",
+    "updated_at": "2026-01-01T00:00:00Z",
+}
+
+
+@pytest.fixture(autouse=True)
+def stub_api(monkeypatch):
+    server = HTTPServer(("127.0.0.1", 0), _Stub)
+    threading.Thread(target=server.serve_forever, daemon=True).start()
+    _Stub.calls = []
+    monkeypatch.setenv("DIGIARENA_API_URL", f"http://127.0.0.1:{server.server_port}")
+    monkeypatch.setenv("DIGIARENA_API_KEY", KEY)
+    yield server
+    server.shutdown()
+
+
+def test_scenes_list_and_get():
+    scenes = da.scenes.list(query="kitchen")
+    assert scenes[0].id == "u1/kitchen_001"
+    assert scenes[0].public is True
+    s = da.scenes.get("u1/kitchen_001")
+    assert s.name == "Kitchen 001"
+    # list(public=True) 不带 Authorization（公开面）；get 带（可见 private）
+    list_call = next(c for c in _Stub.calls if c[1].startswith("/api/v1/scenes?"))
+    assert list_call[3] is None
+    get_call = next(c for c in _Stub.calls if c[1] == "/api/v1/scenes/u1/kitchen_001")
+    assert get_call[3] == f"Bearer {KEY}"
+
+
+def test_usage_sends_bearer_key():
+    assert da.usage() == {"sim_minutes_used": 0}
+    assert _Stub.calls[-1][3] == f"Bearer {KEY}"
+
+
+def test_deploy_not_implemented_maps_to_typed_error():
+    with pytest.raises(errors.NotImplementedYetError) as ei:
+        da.deploy(scene="u1/kitchen_001")
+    assert "Possible fixes" in str(ei.value)
+    assert ei.value.status == 501
+    # 请求体形状(冻结面)
+    call = next(c for c in _Stub.calls if c[1] == "/api/v1/gyms")
+    assert call[2] == {"scene_id": "u1/kitchen_001", "task_id": None,
+                       "tier": "auto", "region": None}
+
+
+def test_unauthorized_maps_to_auth_error(monkeypatch):
+    monkeypatch.setenv("DIGIARENA_API_KEY", "da_live_wrong")
+    with pytest.raises(errors.AuthError):
+        da.usage()
+
+
+def test_missing_key_raises_before_network(monkeypatch, tmp_path):
+    monkeypatch.delenv("DIGIARENA_API_KEY", raising=False)
+    monkeypatch.setenv("XDG_CONFIG_HOME", str(tmp_path))  # empty credentials
+    with pytest.raises(errors.AuthError) as ei:
+        da.usage()
+    assert "digiarena login" in str(ei.value)
+
+
+def test_login_saves_credentials(monkeypatch, tmp_path, capsys):
+    monkeypatch.setenv("XDG_CONFIG_HOME", str(tmp_path))
+    monkeypatch.delenv("DIGIARENA_API_KEY", raising=False)
+    # config 模块在 import 时解析了路径，重新加载让 XDG 生效
+    import importlib
+
+    from digiarena import config as cfg
+    importlib.reload(cfg)
+    cfg.login(key="da_live_saved")
+    assert cfg.api_key() == "da_live_saved"
+    cred = tmp_path / "digiarena" / "credentials"
+    assert cred.is_file()
+    assert (cred.stat().st_mode & 0o777) == 0o600
+
+
+def test_benchmarks_public_no_auth():
+    assert da.benchmarks.list() == [{"id": "tabletop-v1"}]
+    assert _Stub.calls[-1][3] is None
+
+
+def test_gym_handle_context_manager():
+    g = da.GymHandle(gym_id="g1", status="ready", url="http://x", control_token="t")
+    with pytest.raises(errors.ApiError):
+        # DELETE /api/v1/gyms/g1 → stub 404 → typed error（形状即契约）
+        with g:
+            pass