Merge branch 'main' into pierre-readme

Author: Pierre

pyproject.toml

@@ -1,6 +1,6 @@
 [tool.poetry]
 name = "workflowai"
-version = "0.6.0.dev11"
+version = "0.6.0.dev12"
 description = ""
 authors = ["Guillaume Aquilina <guillaume@workflowai.com>"]
 readme = "README.md"

workflowai/__init__.py

@@ -1,9 +1,9 @@
-import os
 from collections.abc import Callable, Iterable
 from typing import Any, Optional
 
 from typing_extensions import deprecated
 
+from workflowai import env
 from workflowai.core.client._types import AgentDecorator
 from workflowai.core.client.client import WorkflowAI as WorkflowAI
 from workflowai.core.domain import model
@@ -23,8 +23,8 @@ def _build_client(
     default_version: Optional[VersionReference] = None,
 ):
     return WorkflowAI(
-        endpoint=endpoint or os.getenv("WORKFLOWAI_API_URL"),
-        api_key=api_key or os.getenv("WORKFLOWAI_API_KEY", ""),
+        endpoint=endpoint or env.WORKFLOWAI_API_URL,
+        api_key=api_key or env.WORKFLOWAI_API_KEY,
         default_version=default_version,
     )
 
@@ -33,7 +33,7 @@ def _build_client(
 shared_client: WorkflowAI = _build_client()
 
 # The default model to use when running agents without a deployment
-DEFAULT_MODEL: "model.ModelOrStr" = os.getenv("WORKFLOWAI_DEFAULT_MODEL", "gemini-1.5-pro-latest")
+DEFAULT_MODEL: "model.ModelOrStr" = env.WORKFLOWAI_DEFAULT_MODEL
 
 
 def init(api_key: Optional[str] = None, url: Optional[str] = None, default_version: Optional[VersionReference] = None):

workflowai/core/domain/run.py

@@ -4,6 +4,7 @@
 from pydantic import BaseModel, Field  # pyright: ignore [reportUnknownVariableType]
 from typing_extensions import Unpack
 
+from workflowai import env
 from workflowai.core import _common_types
 from workflowai.core.client import _types
 from workflowai.core.domain.errors import BaseError
@@ -120,6 +121,10 @@ def __str__(self) -> str:
         """Return a string representation of the run."""
         return self.format_output()
 
+    @property
+    def run_url(self):
+        return f"{env.WORKFLOWAI_APP_URL}/agents/{self.agent_id}/runs/{self.id}"
+
 
 class _AgentBase(Protocol, Generic[AgentOutput]):
     async def reply(

workflowai/core/domain/run_test.py

@@ -1,4 +1,4 @@
-from unittest.mock import Mock
+from unittest.mock import Mock, patch
 
 import pytest
 from pydantic import BaseModel
@@ -114,3 +114,9 @@ def test_format_output_no_cost_latency() -> None:
 =================================================="""
 
     assert run.format_output() == expected
+
+
+class TestRunURL:
+    @patch("workflowai.env.WORKFLOWAI_APP_URL", "https://workflowai.hello")
+    def test_run_url(self, run1: Run[_TestOutput]):
+        assert run1.run_url == "https://workflowai.hello/agents/agent-1/runs/test-id"

workflowai/env.py

@@ -0,0 +1,22 @@
+"""A file to describe all environment variables"""
+
+import os
+
+WORKFLOWAI_DEFAULT_MODEL = os.getenv("WORKFLOWAI_DEFAULT_MODEL", "gemini-1.5-pro-latest")
+
+WORKFLOWAI_API_URL = os.getenv("WORKFLOWAI_API_URL")
+
+
+def _default_api_url():
+    if not WORKFLOWAI_API_URL:
+        return "https://workflowai.com"
+    if WORKFLOWAI_API_URL.startswith("https://run."):
+        return "https://" + WORKFLOWAI_API_URL.removeprefix("https://run.")
+    if WORKFLOWAI_API_URL.startswith("https://api."):
+        return "https://" + WORKFLOWAI_API_URL.removeprefix("https://api.")
+    return "https://workflowai.com"
+
+
+WORKFLOWAI_APP_URL = os.getenv("WORKFLOWAI_APP_URL", _default_api_url)
+
+WORKFLOWAI_API_KEY = os.getenv("WORKFLOWAI_API_KEY", "")

workflowai/env_test.py

@@ -0,0 +1,20 @@
+from typing import Optional
+from unittest.mock import patch
+
+import pytest
+
+from .env import _default_api_url  # pyright: ignore[reportPrivateUsage]
+
+
+@pytest.mark.parametrize(
+    ("api_url", "expected"),
+    [
+        ("https://run.workflowai.com", "https://workflowai.com"),
+        ("https://api.workflowai.com", "https://workflowai.com"),
+        ("https://workflowai.com", "https://workflowai.com"),
+        (None, "https://workflowai.com"),
+    ],
+)
+def test_default_api_url(api_url: Optional[str], expected: str):
+    with patch("workflowai.env.WORKFLOWAI_API_URL", api_url):
+        assert _default_api_url() == expected