docs/source/core.md

Core API

The openenv.core package provides the core abstractions for building and running environments. For an end-to-end tutorial on building environments with OpenEnv, see the building an environment guide.

Server

Environment server primitives

.. automodule:: openenv.core.env_server.interfaces
   :members:
   :undoc-members:
   :show-inheritance:

Types

.. automodule:: openenv.core.env_server.types
   :members:
   :undoc-members:
   :show-inheritance:

Exceptions

.. automodule:: openenv.core.env_server.exceptions
   :members:
   :undoc-members:
   :show-inheritance:

HTTP server utilities

.. automodule:: openenv.core.env_server.http_server
   :members:
   :undoc-members:
   :show-inheritance:

Web interface helpers

.. automodule:: openenv.core.env_server.web_interface
   :members:
   :undoc-members:
   :show-inheritance:

Serialization

.. automodule:: openenv.core.env_server.serialization
   :members:
   :undoc-members:
   :show-inheritance:

Transforms

.. automodule:: openenv.core.env_server.base_transforms
   :members:
   :undoc-members:
   :show-inheritance:

Route configuration

.. automodule:: openenv.core.env_server.route_config
   :members:
   :undoc-members:
   :show-inheritance:

Clients

Base client

.. automodule:: openenv.core.env_client
   :members:
   :undoc-members:
   :show-inheritance:

Synchronous client

.. automodule:: openenv.core.sync_client
   :members:
   :undoc-members:
   :show-inheritance:

Generic client

.. automodule:: openenv.core.generic_client
   :members:
   :undoc-members:
   :show-inheritance:

LLM client

.. automodule:: openenv.core.llm_client
   :members:
   :undoc-members:
   :show-inheritance:

Shared dataclasses

.. automodule:: openenv.core.client_types
   :members:
   :undoc-members:
   :show-inheritance:

MCP (Model Context Protocol)

MCP environment

.. automodule:: openenv.core.env_server.mcp_environment
   :members:
   :undoc-members:
   :show-inheritance:

MCP types

.. automodule:: openenv.core.env_server.mcp_types
   :members:
   :undoc-members:
   :show-inheritance:

MCP client

.. automodule:: openenv.core.mcp_client
   :members:
   :undoc-members:
   :show-inheritance:

Rubrics

.. automodule:: openenv.core.rubrics.base
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openenv.core.rubrics.containers
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openenv.core.rubrics.trajectory
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openenv.core.rubrics.llm_judge
   :members:
   :undoc-members:
   :show-inheritance:

Tools

.. automodule:: openenv.core.tools.git_server_client
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openenv.core.tools.local_python_executor
   :members:
   :undoc-members:
   :show-inheritance:

Container providers

.. automodule:: openenv.core.containers.runtime.providers
   :members:
   :undoc-members:
   :show-inheritance:

.. automodule:: openenv.core.containers.runtime.uv_provider
   :members:
   :undoc-members:
   :show-inheritance: