futurehouse-client 0.0.1__py3-none-any.whl

futurehouse_client/models/rest.py

@@ -0,0 +1,19 @@
+from pydantic import BaseModel, JsonValue
+
+
+class FinalEnvironmentRequest(BaseModel):
+    status: str
+
+
+class StoreAgentStatePostRequest(BaseModel):
+    agent_id: str
+    step: str
+    state: JsonValue
+    trajectory_timestep: int
+
+
+class StoreEnvironmentFrameRequest(BaseModel):
+    agent_state_point_in_time: str
+    current_agent_step: str
+    state: JsonValue
+    trajectory_timestep: int

futurehouse_client/utils/module_utils.py

@@ -0,0 +1,149 @@
+import ast
+import importlib.util
+import logging
+import types
+from pathlib import Path
+
+logger = logging.getLogger(__name__)
+
+
+def extract_docstring_from_file(
+    file_path: Path,
+    class_name: str,
+    function_name: str,
+) -> str | None:
+    """Extract the docstring for a specific function in a class without importing the module.
+
+    Args:
+        file_path (Path): Path to the Python file.
+        class_name (str): Name of the class containing the function.
+        function_name (str): Name of the function.
+
+    Returns:
+        str: The docstring of the function, or None if not found.
+
+    """
+    with file_path.open(encoding="utf-8") as file:
+        source = file.read()
+
+    tree = ast.parse(source)
+
+    for node in tree.body:
+        if isinstance(node, ast.ClassDef) and node.name == class_name:
+            for class_node in node.body:
+                if (
+                    isinstance(class_node, ast.FunctionDef)
+                    and class_node.name == function_name
+                ):
+                    return ast.get_docstring(class_node)
+    return None
+
+
+def load_module(file_path: Path, package_name: str) -> types.ModuleType | None:
+    """Load a Python file as part of a package.
+
+    Args:
+        file_path (Path): Path to the Python file.
+        package_name (str): Full package name (e.g., "envs.dummy_env.env").
+
+    Returns:
+        Module: The loaded module.
+
+    """
+    spec = importlib.util.spec_from_file_location(package_name, file_path)
+    if not spec:
+        return None
+    return importlib.util.module_from_spec(spec)
+
+
+def fetch_environment_function_docstring(
+    environment_name: str,
+    directory: Path,
+    function_name: str,
+) -> str | None:
+    """Retrieve the docstring for a specific function within a class, identified by an environment-style module path.
+
+    The function attempts the following:
+    1. Parse the file inferred from the environment name (e.g., environment "my_env.module.MyClass"
+       attempts to find `directory/my_env/module.py`).
+    2. If not found there, recursively searches all `.py` files under `directory` for a class
+       with the given name containing the specified function.
+
+    Args:
+        environment_name (str): The environment name in dot notation
+                                (e.g., "package.module.ClassName").
+        directory (Path): The base directory containing the environment files.
+        function_name (str): The name of the function to retrieve the docstring for.
+
+    Raises:
+        ValueError: If multiple classes with the same name are found in different files
+                    (making the intended class ambiguous), an error is raised requiring
+                    disambiguation.
+
+    Returns:
+        str | None: The docstring of the specified function, or None if not found.
+
+    """
+    parts = environment_name.split(".")
+    class_name = parts[-1]
+
+    guessed_file_path = directory / ("/".join(parts[1:-1]) + ".py")
+    if guessed_file_path.exists():
+        doc = extract_docstring_from_file(guessed_file_path, class_name, function_name)
+        if doc:
+            return doc
+
+    matches = []
+    for py_file in directory.rglob("*.py"):
+        doc = extract_docstring_from_file(py_file, class_name, function_name)
+        if doc:
+            matches.append((py_file, doc))
+
+    if not matches:
+        return None
+    if len(matches) == 1:
+        return matches[0][1]
+    match_paths = [str(m[0]) for m in matches]
+    raise ValueError(
+        f"Multiple classes named '{class_name}' found in:\n"
+        + "\n".join(match_paths)
+        + "\nPlease specify a more explicit path or ensure unique class names.",
+    )
+
+
+class OrganizationSelector:
+    @staticmethod
+    def select_organization(organizations: list[str]) -> str | None:
+        """Prompts the user to select an organization from a list.
+
+        Args:
+            organizations: List of organization names/IDs
+
+        Returns:
+            Selected organization name/ID or None if selection was cancelled
+
+        """
+        if not organizations:
+            raise ValueError("User does not belong to any organizations")
+
+        if len(organizations) == 1:
+            logger.debug(f"Only one organization available: {organizations[0]}")
+            return organizations[0]
+
+        print("\nAvailable organizations:")
+        for idx, org in enumerate(organizations, 1):
+            print(f"[{idx}]. {org}")
+
+        while True:
+            try:
+                selection = input("\nSelect an organization number (or 'q' to quit): ")
+
+                if selection.lower().strip() == "q":
+                    return None
+
+                idx = int(selection)
+                if 1 <= idx <= len(organizations):
+                    return organizations[idx - 1]
+                print(f"Please enter a number between 1 and {len(organizations)}")
+            except ValueError:
+                print("Please enter a valid number or 'q' to quit")

futurehouse_client-0.0.1.dist-info/METADATA

@@ -0,0 +1,151 @@
+Metadata-Version: 2.4
+Name: futurehouse-client
+Version: 0.0.1
+Summary: A client for interacting with endpoints of the FutureHouse service.
+Author-email: FutureHouse technical staff <hello@futurehouse.org>
+Classifier: Operating System :: OS Independent
+Classifier: Programming Language :: Python :: 3 :: Only
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python
+Requires-Python: <3.13,>=3.11
+Description-Content-Type: text/markdown
+Requires-Dist: cloudpickle
+Requires-Dist: dm-tree<0.1.9
+Requires-Dist: fhaviary
+Requires-Dist: httpx
+Requires-Dist: ldp>=0.22.0
+Requires-Dist: pydantic
+Requires-Dist: python-dotenv
+Requires-Dist: tenacity
+Provides-Extra: dev
+Requires-Dist: black; extra == "dev"
+Requires-Dist: jupyter; extra == "dev"
+Requires-Dist: jupyterlab; extra == "dev"
+Requires-Dist: mypy; extra == "dev"
+Requires-Dist: notebook; extra == "dev"
+Requires-Dist: pre-commit; extra == "dev"
+Requires-Dist: pylint; extra == "dev"
+Requires-Dist: pylint-per-file-ignores; extra == "dev"
+Requires-Dist: pylint-pydantic; extra == "dev"
+Requires-Dist: pytest; extra == "dev"
+Requires-Dist: pytest-rerunfailures; extra == "dev"
+Requires-Dist: pytest-subtests; extra == "dev"
+Requires-Dist: pytest-timeout; extra == "dev"
+Requires-Dist: pytest-xdist; extra == "dev"
+Requires-Dist: ruff; extra == "dev"
+Requires-Dist: setuptools_scm; extra == "dev"
+
+# crow-client
+
+A client for interacting with endpoints of the FutureHouse crow service.
+
+## Installation
+
+```bash
+uv pip install crow-client
+```
+
+## Usage
+
+The CrowClient provides simple functions to deploy and monitor your crow.
+
+In the case of environments the deployment looks like this
+
+```python
+from pathlib import Path
+from crow_client import CrowClient
+from crow_client.models import CrowDeploymentConfig
+
+client = CrowClient()
+
+crow = CrowDeploymentConfig(
+    path=Path("../envs/dummy_env"),
+    environment="dummy_env.env.DummyEnv",
+    requires_aviary_internal=False,
+    environment_variables={"SAMPLE_ENV_VAR": "sample_val"},
+    agent="ldp.agent.SimpleAgent",
+)
+
+client.create_crow(crow)
+
+# checks the status
+client.get_build_status()
+```
+
+For functional environments we don't need to pass the file path and can pass the environment builder instead
+
+```python
+from aviary.core import fenv
+import numpy as np
+
+
+def function_to_use_here(inpste: str):
+    a = np.array(np.asmatrix("1 2; 3 4"))
+    return inpste
+
+
+@fenv.start()
+def my_env(topic: str):
+    """
+    Here is the doc string describing the task.
+    """
+    a = np.array(np.asmatrix("1 2; 3 4"))
+    return f"Write a sad story about {topic}", {"chosen_topic": topic}
+
+
+@my_env.tool()
+def print_story(story: str, state) -> None:
+    """Print the story and complete the task"""
+    print(story)
+    print(function_to_use_here(story))
+    state.reward = 1
+    state.done = True
+
+
+from crow_client import CrowClient
+from crow_client.models import CrowDeploymentConfig, Stage
+from crow_client.clients.rest_client import generate_requirements
+
+client = CrowClient(stage=Stage.LOCAL)
+
+crow = CrowDeploymentConfig(
+    functional_environment=my_env,
+    environment="my_env",
+    requires_aviary_internal=False,
+    environment_variables={"SAMPLE_ENV_VAR": "sample_val"},
+    agent="ldp.agent.SimpleAgent",
+    requirements=generate_requirements(my_env, globals()),
+)
+
+client.create_crow(crow)
+```
+
+This client also provides functions that let you send tasks to an existing crow:
+
+```python
+from crow_client import CrowJob
+
+client = CrowClient()
+
+job_data = {"name": "your-job-name", "query": "your task"}
+client.create_job(job_data)
+
+# checks the status
+client.get_job()
+```
+
+The CrowJobClient provides an interface for managing environment states and agent interactions in the FutureHouse crow service.
+
+```python
+from crow_client import CrowJobClient
+from crow_client.models.app import Stage
+
+client = CrowJobClient(
+    environment="your_environment_name",
+    agent="your_agent_id",
+    auth_token="your_auth_token",
+    base_uri=Stage.DEV,
+    trajectory_id=None,
+)
+```

futurehouse_client-0.0.1.dist-info/RECORD

@@ -0,0 +1,14 @@
+futurehouse_client/__init__.py,sha256=SaaBeLHh4K81dONiXxowhsgM-Zr12t1g-phDgwi5iWc,316
+futurehouse_client/clients/__init__.py,sha256=OWJtj6WNJ1GvzA5v-Z8yiKlta47k4dprih-9n7mag40,300
+futurehouse_client/clients/job_client.py,sha256=M0siUz-5Ffri4_fhXXeBb54qnELwMa1hYzosS8bx3ek,8833
+futurehouse_client/clients/rest_client.py,sha256=dEes4lP0JOsuRoFgjhU9uXSogBGFOWgSw8ZfopUJ4w8,24734
+futurehouse_client/models/__init__.py,sha256=VBKYb_2kmxtDwp9LvTL7BEFyioekggQsrQg5I_dhZoI,342
+futurehouse_client/models/app.py,sha256=_MO31xvKJaAztWz4KrV13ty4POg-RuWrGgqmvS9w2bc,22298
+futurehouse_client/models/client.py,sha256=n4HD0KStKLm6Ek9nL9ylP-bkK10yzAaD1uIDF83Qp_A,1828
+futurehouse_client/models/rest.py,sha256=W-wNFTN7HALYFFphw-RQYRMm6_TSa1cl4T-mZ1msk90,393
+futurehouse_client/utils/__init__.py,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
+futurehouse_client/utils/module_utils.py,sha256=aFyd-X-pDARXz9GWpn8SSViUVYdSbuy9vSkrzcVIaGI,4955
+futurehouse_client-0.0.1.dist-info/METADATA,sha256=L7c7KYAcl5HgkRBNmjHS0xnWmZb4QHwmAS3-vrLmtsw,4076
+futurehouse_client-0.0.1.dist-info/WHEEL,sha256=CmyFI0kx5cdEMTLiONQRbGQwjIoR1aIYB7eCAQ4KPJ0,91
+futurehouse_client-0.0.1.dist-info/top_level.txt,sha256=TRuLUCt_qBnggdFHCX4O_BoCu1j2X43lKfIZC-ElwWY,19
+futurehouse_client-0.0.1.dist-info/RECORD,,

futurehouse_client-0.0.1.dist-info/WHEEL

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

futurehouse_client-0.0.1.dist-info/top_level.txt

@@ -0,0 +1 @@
+futurehouse_client