openenv 0.2.3__tar.gz → 0.3.1__tar.gz

{openenv-0.2.3/src/openenv.egg-info → openenv-0.3.1}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: openenv
-Version: 0.2.3
+Version: 0.3.1
 Summary: A unified framework for reinforcement learning environments
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
@@ -37,13 +37,13 @@ Requires-Dist: tomli-w>=1.2.0; extra == "cli"
 Provides-Extra: docs
 Requires-Dist: sphinx==7.2.6; extra == "docs"
 Requires-Dist: pytorch-sphinx-theme2; extra == "docs"
-Requires-Dist: sphinxcontrib.katex==0.9.10; extra == "docs"
-Requires-Dist: docutils<0.21,>=0.18.1; extra == "docs"
+Requires-Dist: sphinxcontrib.katex==0.9.11; extra == "docs"
+Requires-Dist: docutils<0.23,>=0.18.1; extra == "docs"
 Requires-Dist: sphinx-design==0.6.1; extra == "docs"
-Requires-Dist: sphinxcontrib-mermaid==1.0.0; extra == "docs"
+Requires-Dist: sphinxcontrib-mermaid==2.0.2; extra == "docs"
 Requires-Dist: myst-parser; extra == "docs"
 Requires-Dist: sphinxext-opengraph; extra == "docs"
-Requires-Dist: sphinx-sitemap==2.7.1; extra == "docs"
+Requires-Dist: sphinx-sitemap==2.9.0; extra == "docs"
 Requires-Dist: sphinx-gallery>=0.14.0; extra == "docs"
 Requires-Dist: matplotlib; extra == "docs"
 Requires-Dist: nest-asyncio; extra == "docs"
@@ -75,7 +75,7 @@ An e2e framework for creating, deploying and using isolated execution environmen
 
 ## Quick Start
 
-Install the OpenEnv core package:
+Install the OpenEnv package:
 
 ```bash
 pip install openenv
@@ -91,7 +91,7 @@ Then use the environment:
 
 ```python
 import asyncio
-from echo_env import EchoAction, EchoEnv
+from echo_env import CallToolAction, EchoEnv
 
 async def main():
     # Connect to a running Space (async context manager)
@@ -101,9 +101,14 @@ async def main():
         print(result.observation.echoed_message)  # "Echo environment ready!"
 
         # Send messages
-        result = await client.step(EchoAction(message="Hello, World!"))
-        print(result.observation.echoed_message)  # "Hello, World!"
-        print(result.reward)  # 1.3 (based on message length)
+        result = await client.step(
+            CallToolAction(
+                tool_name="echo_message",
+                arguments={"message": "Hello, World!"},
+            )
+        )
+        print(result.observation.result)  # "Hello, World!"
+        print(result.reward)
 
 asyncio.run(main())
 ```
@@ -111,16 +116,21 @@ asyncio.run(main())
 **Synchronous usage** is also supported via the `.sync()` wrapper:
 
 ```python
-from echo_env import EchoAction, EchoEnv
+from echo_env import CallToolAction, EchoEnv
 
 # Use .sync() for synchronous context manager
 with EchoEnv(base_url="https://openenv-echo-env.hf.space").sync() as client:
     result = client.reset()
-    result = client.step(EchoAction(message="Hello, World!"))
-    print(result.observation.echoed_message)
+    result = client.step(
+        CallToolAction(
+            tool_name="echo_message",
+            arguments={"message": "Hello, World!"},
+        )
+    )
+    print(result.observation.result)
 ```
 
-For a detailed quick start, check out the [docs page](https://meta-pytorch.org/OpenEnv/quickstart/).
+For a detailed quick start, check out the [docs page](https://meta-pytorch.org/OpenEnv/auto_getting_started/index.html).
 
 ## OpenEnv on partner platforms:
 
@@ -138,12 +148,15 @@ In addition to making it easier for researchers and RL framework writers, we als
 
 The OpenEnv CLI (`openenv`) provides commands to initialize new environments and deploy them to Hugging Face Spaces.
 
+OpenEnv is openly governed by a technical committee that includes Hugging Face, Unsloth, Reflection, and Meta PyTorch. The committee coordinates project direction, major technical decisions, RFCs, and release planning through the public issue tracker, pull requests, and RFC process.
+
 > ⚠️ **Early Development Warning** OpenEnv is currently in an experimental
 > stage. You should expect bugs, incomplete features, and APIs that may change
-> in future versions. The project welcomes bugfixes, but to make sure things are
-> well coordinated you should discuss any significant change before starting the
-> work. It's recommended that you signal your intention to contribute in the
-> issue tracker, either by filing a new issue or by claiming an existing one.
+> in future versions. The project welcomes bugfixes, but significant changes
+> should be discussed before implementation so the technical committee and
+> community can coordinate scope, compatibility, and release timing. It's
+> recommended that you signal your intention to contribute in the issue tracker,
+> either by filing a new issue or by claiming an existing one.
 
 ### RFCs
 
@@ -299,7 +312,7 @@ See [`envs/README.md`](envs/README.md) for a complete guide on building environm
 
 To use an environment:
 1. Install the client: `pip install git+https://huggingface.co/spaces/openenv/echo-env`
-2. Import: `from echo_env import EchoAction, EchoEnv`
+2. Import: `from echo_env import CallToolAction, EchoEnv`
 3. Use async (recommended) or sync API:
 
 **Async (recommended):**
@@ -427,12 +440,12 @@ See the [Oumi example](https://github.com/oumi-ai/oumi/blob/main/notebooks/Oumi%
 | [Atari Environment](envs/atari_env/README.md) | Classic Arcade Learning Environment tasks for RL benchmarking. |
 | [FinRL Environment](envs/finrl_env/README.md) | Financial market simulations for algorithmic trading experiments. |
 
-> Browse the full catalog of community environments at [meta-pytorch.org/OpenEnv/environments](https://meta-pytorch.org/OpenEnv/environments/).
+> Browse the full catalog of community environments at [meta-pytorch.org/OpenEnv/environments](https://meta-pytorch.org/OpenEnv/environments.html).
 
 ## Community Support & Acknowledgments
-This is an open and community-centric project. If you would like to add your name here, please put up a pull request and tag @jspisak for review. Ty!!
+This is an open and community-centric project, governed in public by a technical committee that includes Hugging Face, Unsloth, Reflection, and Meta PyTorch. If you would like to add your project or organization here, please open a pull request for maintainer review.
 
-Supporters include: Meta-PyTorch, Hugging Face, [Scaler AI Labs](https://scalerailabs.com), [Patronus AI](https://patronus.ai), [Surge AI](https://surgehq.ai), [LastMile AI](https://www.lastmileai.dev), Unsloth AI, Reflection AI, vLLM, SkyRL (UC-Berkeley), LightningAI, Axolotl AI, Stanford Scaling Intelligence Lab, Mithril, [OpenMined](https://openmined.org/), [Fleet AI](https://fleetai.com), [Halluminate](https://halluminate.ai/), [Turing](https://www.turing.com/), [Scale AI](https://scale.com/) ..
+Supporters include: Meta-PyTorch, Hugging Face, [Scaler AI Labs](https://scalerailabs.com), [Patronus AI](https://patronus.ai), [Surge AI](https://surgehq.ai), [LastMile AI](https://www.lastmileai.dev), Unsloth, Reflection, vLLM, SkyRL (UC-Berkeley), LightningAI, Axolotl AI, Stanford Scaling Intelligence Lab, Mithril, [OpenMined](https://openmined.org/), [Fleet AI](https://fleetai.com), [Halluminate](https://halluminate.ai/), [Turing](https://www.turing.com/), [Scale AI](https://scale.com/), [Scorecard](https://www.scorecard.io/) ..
 
 And we'd also like to acknowledge the team at Farama Foundation as the OpenEnv API was heavily inspired by the work you all have done on Gymnasium. Cheers!
 

{openenv-0.2.3 → openenv-0.3.1}/README.md

@@ -15,7 +15,7 @@ An e2e framework for creating, deploying and using isolated execution environmen
 
 ## Quick Start
 
-Install the OpenEnv core package:
+Install the OpenEnv package:
 
 ```bash
 pip install openenv
@@ -31,7 +31,7 @@ Then use the environment:
 
 ```python
 import asyncio
-from echo_env import EchoAction, EchoEnv
+from echo_env import CallToolAction, EchoEnv
 
 async def main():
     # Connect to a running Space (async context manager)
@@ -41,9 +41,14 @@ async def main():
         print(result.observation.echoed_message)  # "Echo environment ready!"
 
         # Send messages
-        result = await client.step(EchoAction(message="Hello, World!"))
-        print(result.observation.echoed_message)  # "Hello, World!"
-        print(result.reward)  # 1.3 (based on message length)
+        result = await client.step(
+            CallToolAction(
+                tool_name="echo_message",
+                arguments={"message": "Hello, World!"},
+            )
+        )
+        print(result.observation.result)  # "Hello, World!"
+        print(result.reward)
 
 asyncio.run(main())
 ```
@@ -51,16 +56,21 @@ asyncio.run(main())
 **Synchronous usage** is also supported via the `.sync()` wrapper:
 
 ```python
-from echo_env import EchoAction, EchoEnv
+from echo_env import CallToolAction, EchoEnv
 
 # Use .sync() for synchronous context manager
 with EchoEnv(base_url="https://openenv-echo-env.hf.space").sync() as client:
     result = client.reset()
-    result = client.step(EchoAction(message="Hello, World!"))
-    print(result.observation.echoed_message)
+    result = client.step(
+        CallToolAction(
+            tool_name="echo_message",
+            arguments={"message": "Hello, World!"},
+        )
+    )
+    print(result.observation.result)
 ```
 
-For a detailed quick start, check out the [docs page](https://meta-pytorch.org/OpenEnv/quickstart/).
+For a detailed quick start, check out the [docs page](https://meta-pytorch.org/OpenEnv/auto_getting_started/index.html).
 
 ## OpenEnv on partner platforms:
 
@@ -78,12 +88,15 @@ In addition to making it easier for researchers and RL framework writers, we als
 
 The OpenEnv CLI (`openenv`) provides commands to initialize new environments and deploy them to Hugging Face Spaces.
 
+OpenEnv is openly governed by a technical committee that includes Hugging Face, Unsloth, Reflection, and Meta PyTorch. The committee coordinates project direction, major technical decisions, RFCs, and release planning through the public issue tracker, pull requests, and RFC process.
+
 > ⚠️ **Early Development Warning** OpenEnv is currently in an experimental
 > stage. You should expect bugs, incomplete features, and APIs that may change
-> in future versions. The project welcomes bugfixes, but to make sure things are
-> well coordinated you should discuss any significant change before starting the
-> work. It's recommended that you signal your intention to contribute in the
-> issue tracker, either by filing a new issue or by claiming an existing one.
+> in future versions. The project welcomes bugfixes, but significant changes
+> should be discussed before implementation so the technical committee and
+> community can coordinate scope, compatibility, and release timing. It's
+> recommended that you signal your intention to contribute in the issue tracker,
+> either by filing a new issue or by claiming an existing one.
 
 ### RFCs
 
@@ -239,7 +252,7 @@ See [`envs/README.md`](envs/README.md) for a complete guide on building environm
 
 To use an environment:
 1. Install the client: `pip install git+https://huggingface.co/spaces/openenv/echo-env`
-2. Import: `from echo_env import EchoAction, EchoEnv`
+2. Import: `from echo_env import CallToolAction, EchoEnv`
 3. Use async (recommended) or sync API:
 
 **Async (recommended):**
@@ -367,12 +380,12 @@ See the [Oumi example](https://github.com/oumi-ai/oumi/blob/main/notebooks/Oumi%
 | [Atari Environment](envs/atari_env/README.md) | Classic Arcade Learning Environment tasks for RL benchmarking. |
 | [FinRL Environment](envs/finrl_env/README.md) | Financial market simulations for algorithmic trading experiments. |
 
-> Browse the full catalog of community environments at [meta-pytorch.org/OpenEnv/environments](https://meta-pytorch.org/OpenEnv/environments/).
+> Browse the full catalog of community environments at [meta-pytorch.org/OpenEnv/environments](https://meta-pytorch.org/OpenEnv/environments.html).
 
 ## Community Support & Acknowledgments
-This is an open and community-centric project. If you would like to add your name here, please put up a pull request and tag @jspisak for review. Ty!!
+This is an open and community-centric project, governed in public by a technical committee that includes Hugging Face, Unsloth, Reflection, and Meta PyTorch. If you would like to add your project or organization here, please open a pull request for maintainer review.
 
-Supporters include: Meta-PyTorch, Hugging Face, [Scaler AI Labs](https://scalerailabs.com), [Patronus AI](https://patronus.ai), [Surge AI](https://surgehq.ai), [LastMile AI](https://www.lastmileai.dev), Unsloth AI, Reflection AI, vLLM, SkyRL (UC-Berkeley), LightningAI, Axolotl AI, Stanford Scaling Intelligence Lab, Mithril, [OpenMined](https://openmined.org/), [Fleet AI](https://fleetai.com), [Halluminate](https://halluminate.ai/), [Turing](https://www.turing.com/), [Scale AI](https://scale.com/) ..
+Supporters include: Meta-PyTorch, Hugging Face, [Scaler AI Labs](https://scalerailabs.com), [Patronus AI](https://patronus.ai), [Surge AI](https://surgehq.ai), [LastMile AI](https://www.lastmileai.dev), Unsloth, Reflection, vLLM, SkyRL (UC-Berkeley), LightningAI, Axolotl AI, Stanford Scaling Intelligence Lab, Mithril, [OpenMined](https://openmined.org/), [Fleet AI](https://fleetai.com), [Halluminate](https://halluminate.ai/), [Turing](https://www.turing.com/), [Scale AI](https://scale.com/), [Scorecard](https://www.scorecard.io/) ..
 
 And we'd also like to acknowledge the team at Farama Foundation as the OpenEnv API was heavily inspired by the work you all have done on Gymnasium. Cheers!
 

{openenv-0.2.3 → openenv-0.3.1}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "openenv"
-version = "0.2.3"
+version = "0.3.1"
 description = "A unified framework for reinforcement learning environments"
 readme = "README.md"
 requires-python = ">=3.10"
@@ -52,13 +52,13 @@ cli = [
 docs = [
     "sphinx==7.2.6",
     "pytorch-sphinx-theme2",
-    "sphinxcontrib.katex==0.9.10",
-    "docutils>=0.18.1,<0.21",
+    "sphinxcontrib.katex==0.9.11",
+    "docutils>=0.18.1,<0.23",
     "sphinx-design==0.6.1",
-    "sphinxcontrib-mermaid==1.0.0",
+    "sphinxcontrib-mermaid==2.0.2",
     "myst-parser",
     "sphinxext-opengraph",
-    "sphinx-sitemap==2.7.1",
+    "sphinx-sitemap==2.9.0",
     "sphinx-gallery>=0.14.0",
     "matplotlib",
     "nest-asyncio",

{openenv-0.2.3 → openenv-0.3.1}/src/openenv/__init__.py

@@ -17,7 +17,7 @@ __all__ = [
 
 def _load_package_version() -> str:
     """Resolve the installed distribution version for the OpenEnv package."""
-    for distribution_name in ("openenv", "openenv"):
+    for distribution_name in ("openenv", "openenv-core"):
         try:
             return metadata.version(distribution_name)
         except metadata.PackageNotFoundError:

{openenv-0.2.3 → openenv-0.3.1}/src/openenv/auto/_discovery.py

@@ -369,14 +369,14 @@ class EnvironmentDiscovery:
             logger.warning(f"Failed to get installed packages: {e}")
             return environments
 
-        # Filter for openenv-* packages (exclude openenv)
+        # Filter for openenv-* environment packages; ignore the legacy core wheel.
         for dist in distributions:
             package_name = dist.metadata["Name"]
 
             if not package_name.startswith("openenv-"):
                 continue
 
-            if package_name == "openenv":
+            if package_name == "openenv-core":
                 continue
 
             # Get module name (e.g., "openenv-echo_env" → "echo_env")

{openenv-0.2.3 → openenv-0.3.1}/src/openenv/cli/__main__.py

@@ -14,7 +14,16 @@ following the Hugging Face CLI pattern.
 import sys
 
 import typer
-from openenv.cli.commands import build, fork, init, push, serve, skills, validate
+from openenv.cli.commands import (
+    build,
+    collect,
+    fork,
+    init,
+    push,
+    serve,
+    skills,
+    validate,
+)
 
 # Create the main CLI app
 app = typer.Typer(
@@ -47,6 +56,10 @@ app.add_typer(
     name="skills",
     help="Manage OpenEnv skills for AI assistants",
 )
+app.command(
+    name="collect",
+    help="Collect rollouts from a deployed OpenEnv environment",
+)(collect.collect)
 
 
 # Entry point for setuptools

{openenv-0.2.3 → openenv-0.3.1}/src/openenv/cli/_validation.py

@@ -11,6 +11,8 @@ This module provides functions to check if environments are properly
 configured for multi-mode deployment (Docker, direct Python, notebooks, clusters).
 """
 
+import ast
+import re
 from pathlib import Path
 from typing import Any
 from urllib.parse import urlparse
@@ -426,6 +428,79 @@ def validate_running_environment(
     return report
 
 
+def _has_main_guard_call(app_content: str) -> bool:
+    """Return True when the module calls main() under a __main__ guard."""
+    try:
+        tree = ast.parse(app_content)
+    except SyntaxError:
+        return (
+            "__name__" in app_content
+            and "__main__" in app_content
+            and "main(" in app_content
+        )
+
+    for node in ast.iter_child_nodes(tree):
+        if not isinstance(node, ast.If):
+            continue
+
+        test = node.test
+        if not (
+            isinstance(test, ast.Compare)
+            and isinstance(test.left, ast.Name)
+            and test.left.id == "__name__"
+            and len(test.ops) == 1
+            and isinstance(test.ops[0], ast.Eq)
+            and len(test.comparators) == 1
+            and isinstance(test.comparators[0], ast.Constant)
+            and test.comparators[0].value == "__main__"
+        ):
+            continue
+
+        for guarded_node in node.body:
+            for candidate in ast.walk(guarded_node):
+                if isinstance(candidate, ast.Call):
+                    func = candidate.func
+                    if isinstance(func, ast.Name) and func.id == "main":
+                        return True
+
+    return False
+
+
+_OPENENV_RUNTIME_DEP_RE = re.compile(r"^openenv(?:\s*(?:$|[<>=!~@;])|\[)")
+_LEGACY_OPENENV_CORE_DEP_RE = re.compile(r"^openenv-core(?:\s*(?:$|[<>=!~@;])|\[)")
+_OPENENV_DOCKER_INSTALL_RE = re.compile(
+    r"(?<![a-z0-9_.-])openenv(?:\s*(?:$|[<>=!~@;])|\[)"
+)
+
+
+def _dockerfile_installs_openenv_runtime(env_path: Path) -> bool:
+    """Return True when a Docker deployment installs OpenEnv outside pyproject."""
+    for dockerfile_path in (
+        env_path / "server" / "Dockerfile",
+        env_path / "Dockerfile",
+    ):
+        if not dockerfile_path.exists():
+            continue
+
+        try:
+            dockerfile = dockerfile_path.read_text(encoding="utf-8")
+        except OSError:
+            continue
+
+        for line in dockerfile.splitlines():
+            stripped = line.strip().lower()
+            if not stripped or stripped.startswith("#"):
+                continue
+            if _OPENENV_DOCKER_INSTALL_RE.search(stripped):
+                return True
+            if "openenv-core" in stripped:
+                return True
+            if "git+https://github.com/meta-pytorch/openenv" in stripped:
+                return True
+
+    return False
+
+
 def validate_multi_mode_deployment(env_path: Path) -> tuple[bool, list[str]]:
     """
     Validate that an environment is ready for multi-mode deployment.
@@ -475,15 +550,12 @@ def validate_multi_mode_deployment(env_path: Path) -> tuple[bool, list[str]]:
 
     # Check required dependencies
     deps = [dep.lower() for dep in pyproject.get("project", {}).get("dependencies", [])]
-    has_openenv = any(
-        dep.startswith("openenv") and not dep.startswith("openenv") for dep in deps
-    )
-    has_legacy_core = any(dep.startswith("openenv") for dep in deps)
+    has_openenv = any(_OPENENV_RUNTIME_DEP_RE.match(dep) for dep in deps)
+    has_legacy_core = any(_LEGACY_OPENENV_CORE_DEP_RE.match(dep) for dep in deps)
+    has_dockerfile_core = _dockerfile_installs_openenv_runtime(env_path)
 
-    if not (has_openenv or has_legacy_core):
-        issues.append(
-            "Missing required dependency: openenv>=0.2.0 (or openenv>=0.2.0)"
-        )
+    if not (has_openenv or has_legacy_core or has_dockerfile_core):
+        issues.append("Missing required dependency: openenv>=0.2.0")
 
     # Check server/app.py exists
     server_app = env_path / "server" / "app.py"
@@ -496,7 +568,7 @@ def validate_multi_mode_deployment(env_path: Path) -> tuple[bool, list[str]]:
             issues.append("server/app.py missing main() function")
 
         # Check if main() is callable
-        if "__name__" not in app_content or "main()" not in app_content:
+        if not _has_main_guard_call(app_content):
             issues.append(
                 "server/app.py main() function not callable (missing if __name__ == '__main__')"
             )

{openenv-0.2.3 → openenv-0.3.1}/src/openenv/cli/commands/build.py

@@ -8,6 +8,7 @@
 
 from __future__ import annotations
 
+import re
 import shutil
 import subprocess
 import sys
@@ -21,6 +22,18 @@ from .._cli_utils import console
 
 app = typer.Typer(help="Build Docker images for OpenEnv environments")
 
+_OPENENV_RUNTIME_DEP_RE = re.compile(r"^openenv(?:\s*(?:$|[<>=!~@;])|\[)")
+
+
+def _is_openenv_runtime_dependency(dep: str) -> bool:
+    """Return True for the OpenEnv runtime distribution, not openenv-* envs."""
+    normalized = dep.strip().lower()
+    return (
+        _OPENENV_RUNTIME_DEP_RE.match(normalized) is not None
+        or normalized.startswith("openenv-core")
+        or normalized.startswith("openenv_core")
+    )
+
 
 def _detect_build_context(env_path: Path) -> tuple[str, Path, Path | None]:
     """
@@ -156,19 +169,15 @@ def _prepare_inrepo_build(env_path: Path, repo_root: Path, temp_dir: Path) -> Pa
                     pyproject = tomli.load(f)
                     deps = pyproject.get("project", {}).get("dependencies", [])
 
-                    # Replace openenv/openenv with local reference
+                    # Replace OpenEnv package references with local source.
                     new_deps = []
                     for dep in deps:
-                        if (
-                            dep.startswith("openenv")
-                            or dep.startswith("openenv_core")
-                            or dep.startswith("openenv")
-                        ):
+                        if _is_openenv_runtime_dependency(dep):
                             # Skip - we'll use local core
                             continue
                         new_deps.append(dep)
 
-                    # Write back with local core reference
+                    # Write back with local OpenEnv reference
                     pyproject["project"]["dependencies"] = new_deps + [
                         "openenv @ file:///app/env/openenv"
                     ]