fix: fixed openai-compatible tests

Author: Zecyel

README.md

@@ -61,6 +61,31 @@ For all providers:
 pip install axm-agent[all]
 ```
 
+## 🔑 Configuration
+
+AXM Agent uses environment variables for API credentials:
+
+### OpenAI
+```bash
+export AXM_OPENAI_API_KEY="sk-..."
+```
+
+### Anthropic (Claude)
+```bash
+export AXM_ANTHROPIC_API_KEY="sk-ant-..."
+```
+
+### OpenAI-Compatible Providers (DeepSeek, local LLMs, etc.)
+```bash
+export AXM_OPENAI_COMPATIBLE_API_KEY="your-api-key"
+export AXM_OPENAI_COMPATIBLE_BASE_URL="https://your-endpoint.com/v1"
+```
+
+You can also pass credentials directly when creating agents:
+```python
+agent = Agent("gpt-4", api_key="sk-...", base_url="https://custom-endpoint.com/v1")
+```
+
 ## 🎓 Quick Start
 
 ### Basic Agent

axm/llm/anthropic.py

@@ -1,6 +1,7 @@
 """Anthropic Claude LLM provider"""
 
 import json
+import os
 from typing import Any, AsyncIterator, Dict, Iterator, List, Optional, Type
 
 from pydantic import BaseModel
@@ -18,9 +19,20 @@
 
 
 class AnthropicProvider(LLMProvider):
-    """Anthropic Claude LLM provider"""
+    """Anthropic Claude LLM provider
+
+    Reads AXM_ANTHROPIC_API_KEY from environment if api_key not provided.
+    """
 
     def __init__(self, api_key: Optional[str] = None, base_url: Optional[str] = None):
+        """
+        Initialize Anthropic provider.
+
+        Args:
+            api_key: Anthropic API key (default: $AXM_ANTHROPIC_API_KEY)
+            base_url: Optional base URL for API
+        """
+        api_key = api_key or os.environ.get("AXM_ANTHROPIC_API_KEY")
         self.client = Anthropic(api_key=api_key, base_url=base_url)
         self.async_client = AsyncAnthropic(api_key=api_key, base_url=base_url)
 

axm/llm/openai.py

@@ -1,5 +1,6 @@
 """OpenAI LLM provider"""
 
+import os
 from typing import Any, AsyncIterator, Dict, Iterator, List, Optional, Type
 
 from pydantic import BaseModel
@@ -17,9 +18,20 @@
 
 
 class OpenAIProvider(LLMProvider):
-    """OpenAI LLM provider (GPT-4, GPT-3.5, etc.)"""
+    """OpenAI LLM provider (GPT-4, GPT-3.5, etc.)
+
+    Reads AXM_OPENAI_API_KEY from environment if api_key not provided.
+    """
 
     def __init__(self, api_key: Optional[str] = None, base_url: Optional[str] = None):
+        """
+        Initialize OpenAI provider.
+
+        Args:
+            api_key: OpenAI API key (default: $AXM_OPENAI_API_KEY)
+            base_url: Optional base URL for API
+        """
+        api_key = api_key or os.environ.get("AXM_OPENAI_API_KEY")
         self.client = OpenAI(api_key=api_key, base_url=base_url)
         self.async_client = AsyncOpenAI(api_key=api_key, base_url=base_url)
 

axm/llm/openai_compatible.py

@@ -45,9 +45,7 @@ class OpenAICompatibleProvider(LLMProvider):
     """OpenAI-compatible LLM provider using requests library
 
     Works with any API that follows the OpenAI chat completions format.
-    Automatically reads environment variables in this order:
-    - API Key: OPENAI_COMPATIBLE_API_KEY -> OPENAI_API_KEY
-    - Base URL: OPENAI_COMPATIBLE_BASE_URL -> OPENAI_BASE_URL -> https://api.openai.com/v1
+    Reads AXM_OPENAI_COMPATIBLE_API_KEY and AXM_OPENAI_COMPATIBLE_BASE_URL from environment.
     """
 
     def __init__(
@@ -60,24 +58,15 @@ def __init__(
         Initialize the OpenAI-compatible provider.
 
         Args:
-            api_key: API key for authentication (default: $OPENAI_COMPATIBLE_API_KEY, then $OPENAI_API_KEY)
-            base_url: Base URL for the API (default: $OPENAI_COMPATIBLE_BASE_URL, then $OPENAI_BASE_URL, then https://api.openai.com/v1)
+            api_key: API key for authentication (default: $AXM_OPENAI_COMPATIBLE_API_KEY)
+            base_url: Base URL for the API (default: $AXM_OPENAI_COMPATIBLE_BASE_URL)
             timeout: Request timeout in seconds
         """
-        # Try OPENAI_COMPATIBLE_API_KEY first, fall back to OPENAI_API_KEY
-        self.api_key = (
-            api_key
-            or os.environ.get("OPENAI_COMPATIBLE_API_KEY")
-            or os.environ.get("OPENAI_API_KEY", "")
+        self.api_key = api_key or os.environ.get("AXM_OPENAI_COMPATIBLE_API_KEY", "")
+        self.base_url = (base_url or os.environ.get("AXM_OPENAI_COMPATIBLE_BASE_URL", "")).rstrip(
+            "/"
         )
 
-        # Try OPENAI_COMPATIBLE_BASE_URL first, then OPENAI_BASE_URL, finally default
-        default_base_url = (
-            os.environ.get("OPENAI_COMPATIBLE_BASE_URL")
-            or os.environ.get("OPENAI_BASE_URL")
-            or "https://api.openai.com/v1"
-        )
-        self.base_url = (base_url or default_base_url).rstrip("/")
         self.timeout = timeout
 
     def _get_headers(self) -> Dict[str, str]:

docs/getting_started.md

@@ -21,25 +21,50 @@ pip install axm-agent[anthropic]
 pip install axm-agent[all]
 ```
 
-## Basic Setup
+## Configuration
+
+### Environment Variables
 
-### 1. Set up your API keys
+AXM Agent uses dedicated environment variables for each provider:
+
+**OpenAI:**
+```bash
+export AXM_OPENAI_API_KEY="sk-..."
+```
 
-Create a `.env` file in your project root:
+**Anthropic (Claude):**
+```bash
+export AXM_ANTHROPIC_API_KEY="sk-ant-..."
+```
 
+**OpenAI-Compatible Providers (DeepSeek, Groq, local LLMs, etc.):**
 ```bash
-OPENAI_API_KEY=your_openai_api_key
-ANTHROPIC_API_KEY=your_anthropic_api_key
+export AXM_OPENAI_COMPATIBLE_API_KEY="your-api-key"
+export AXM_OPENAI_COMPATIBLE_BASE_URL="https://your-endpoint.com/v1"
 ```
 
-Or set them in your code:
+### Passing Credentials Directly
+
+You can also pass credentials directly when creating agents:
 
 ```python
-import os
-os.environ["OPENAI_API_KEY"] = "your_key_here"
+from axm import Agent
+
+# OpenAI
+agent = Agent("gpt-4", api_key="sk-...")
+
+# OpenAI-compatible endpoint
+agent = Agent(
+    "deepseek-v3",
+    api_key="your-api-key",
+    base_url="https://ark.cn-beijing.volces.com/api/v3"
+)
+
+# Anthropic
+agent = Agent("claude-3-opus-20240229", api_key="sk-ant-...")
 ```
 
-### 2. Create your first agent
+## Basic Setup
 
 ```python
 from axm import Agent
@@ -276,7 +301,9 @@ Check out the `examples/` directory for complete examples:
 ```python
 # Check if key is set
 import os
-print(os.getenv("OPENAI_API_KEY"))
+print(os.getenv("AXM_OPENAI_API_KEY"))
+print(os.getenv("AXM_ANTHROPIC_API_KEY"))
+print(os.getenv("AXM_OPENAI_COMPATIBLE_API_KEY"))
 
 # Or pass directly
 agent = Agent("gpt-4", api_key="your-key")

examples/openai_compatible_example.py

@@ -3,22 +3,24 @@
 This provider works with any API that follows the OpenAI chat completions format,
 including local LLM servers, custom proxies, or alternative cloud providers.
 
-Environment Variable Priority:
-1. Direct parameters (api_key, base_url) - highest priority
-2. OPENAI_COMPATIBLE_API_KEY and OPENAI_COMPATIBLE_BASE_URL
-3. OPENAI_API_KEY and OPENAI_BASE_URL - fallback
-4. Default: https://api.openai.com/v1
+Environment Variables:
+- AXM_OPENAI_COMPATIBLE_API_KEY: API key for authentication
+- AXM_OPENAI_COMPATIBLE_BASE_URL: Base URL for the API endpoint
+
+Examples:
+  export AXM_OPENAI_COMPATIBLE_BASE_URL="https://your-endpoint.com/v1"
+  export AXM_OPENAI_COMPATIBLE_API_KEY="your-api-key"
 """
 
 from axm.core.agent import Agent
 from axm.core.multi_agent import MultiAgent
 from axm.llm.openai_compatible import OpenAICompatibleProvider
 
-# Example 1: Use OPENAI_COMPATIBLE_* environment variables (RECOMMENDED)
+# Example 1: Use environment variables (RECOMMENDED)
 # Set these in your shell or .env file:
-# export OPENAI_COMPATIBLE_BASE_URL="https://your-endpoint.com/v1"
-# export OPENAI_COMPATIBLE_API_KEY="your-api-key"
-print("=== Example 1: Using OPENAI_COMPATIBLE_* environment variables ===")
+# export AXM_OPENAI_COMPATIBLE_BASE_URL="https://your-endpoint.com/v1"
+# export AXM_OPENAI_COMPATIBLE_API_KEY="your-api-key"
+print("=== Example 1: Using environment variables ===")
 provider_env = OpenAICompatibleProvider()
 print(f"Base URL from env: {provider_env.base_url}")
 print()

qq.py tests/test_mixed_usage.pyqq.py renamed to tests/test_mixed_usage.py

@@ -1,9 +1,11 @@
 """
 Quick Start Script - Get up and running with AXM Agent in seconds!
 
-Run this script to see AXM Agent in action.
-Set your OPENAI_COMPATIBLE_BASE_URL and OPENAI_COMPATIBLE_API_KEY environment variables.
-Or use OPENAI_BASE_URL and OPENAI_API_KEY as fallback.
+Set environment variables:
+  export AXM_OPENAI_COMPATIBLE_BASE_URL="https://ark.cn-beijing.volces.com/api/v3"
+  export AXM_OPENAI_COMPATIBLE_API_KEY="your-api-key"
+
+Then run: python qq.py
 """
 
 import os
@@ -12,20 +14,16 @@
 from axm.core.multi_agent import MultiAgent
 from axm.llm.openai_compatible import OpenAICompatibleProvider
 
+# Configuration
 MODEL = "deepseek-v3-250324"
-# Note: The base_url should end with /v1 (or similar version endpoint)
-# not include /chat/completions - that's added automatically by the provider
-BASE_URL = "https://ark.cn-beijing.volces.com/api/v3"
-API_KEY = os.environ.get("OPENAI_API_KEY", "test-key-please-set-env-var")
-
 
 def demo_basic_agent():
     """Demo 1: Basic agent usage"""
     print("\n" + "=" * 60)
     print("DEMO 1: Basic Agent")
     print("=" * 60 + "\n")
 
-    agent = Agent(model=MODEL, base_url=BASE_URL, api_key=API_KEY)
+    agent = Agent(model=MODEL)
 
     assert isinstance(agent.llm, OpenAICompatibleProvider)
 
@@ -41,7 +39,7 @@ def demo_agent_with_tools():
     print("DEMO 2: Agent with Custom Tools")
     print("=" * 60 + "\n")
 
-    agent = Agent(model=MODEL, base_url=BASE_URL, api_key=API_KEY)
+    agent = Agent(model=MODEL)
 
     @agent.tool
     def get_user_info(user_id: int) -> dict:
@@ -78,7 +76,7 @@ class MovieRecommendation(BaseModel):
         rating: float
         why_recommended: str
 
-    agent = Agent(model=MODEL, base_url=BASE_URL, api_key=API_KEY)
+    agent = Agent(model=MODEL)
     movie = agent.run(
         "Recommend a sci-fi movie for someone who loves AI themes",
         response_format=MovieRecommendation,
@@ -97,7 +95,7 @@ def demo_planning_agent():
     print("DEMO 4: Planning Agent")
     print("=" * 60 + "\n")
 
-    agent = PlanningAgent(model=MODEL, base_url=BASE_URL, api_key=API_KEY)
+    agent = PlanningAgent(model=MODEL)
 
     agent.execute_plan(
         "Research the benefits of Python for data science and create a summary",
@@ -111,14 +109,12 @@ def demo_multi_agent():
     print("DEMO 5: Multi-Agent Collaboration")
     print("=" * 60 + "\n")
 
-    researcher = Agent(model=MODEL, role="researcher", base_url=BASE_URL, api_key=API_KEY)
-    writer = Agent(model=MODEL, role="writer", base_url=BASE_URL, api_key=API_KEY)
+    researcher = Agent(model=MODEL, role="researcher")
+    writer = Agent(model=MODEL, role="writer")
 
     team = MultiAgent(
         [researcher, writer],
-        orchestrator_model=MODEL,
-        base_url=BASE_URL,
-        api_key=API_KEY,
+        orchestrator_model=MODEL
     )
 
     result = team.collaborate(

test_multi_agent_custom_url.py tests/test_multi_agent_custom_url.pytest_multi_agent_custom_url.py renamed to tests/test_multi_agent_custom_url.py

@@ -7,7 +7,7 @@
 
 MODEL = "deepseek-v3-250324"
 BASE_URL = "https://ark.cn-beijing.volces.com/api/v3"
-API_KEY = os.environ.get("OPENAI_API_KEY", "test-key")
+API_KEY = os.environ.get("AXM_OPENAI_COMPATIBLE_API_KEY", "test-key")
 
 
 def test_multi_agent_with_custom_url():
@@ -17,9 +17,7 @@ def test_multi_agent_with_custom_url():
     print("=" * 60 + "\n")
 
     # Create agents with custom base_url
-    researcher = Agent(
-        model=MODEL, role="researcher", base_url=BASE_URL, api_key=API_KEY
-    )
+    researcher = Agent(model=MODEL, role="researcher", base_url=BASE_URL, api_key=API_KEY)
     writer = Agent(model=MODEL, role="writer", base_url=BASE_URL, api_key=API_KEY)
 
     # Verify agents are using OpenAICompatibleProvider
@@ -55,29 +53,29 @@ def test_multi_agent_with_custom_url():
 
 
 def test_environment_variables():
-    """Test that OPENAI_COMPATIBLE_* environment variables work"""
+    """Test that AXM_OPENAI_COMPATIBLE_* environment variables work"""
     print("\n" + "=" * 60)
-    print("TEST: Environment Variables Priority")
+    print("TEST: Environment Variables")
     print("=" * 60 + "\n")
 
     # Set environment variables
-    os.environ["OPENAI_COMPATIBLE_BASE_URL"] = BASE_URL
-    os.environ["OPENAI_COMPATIBLE_API_KEY"] = API_KEY
+    os.environ["AXM_OPENAI_COMPATIBLE_BASE_URL"] = BASE_URL
+    os.environ["AXM_OPENAI_COMPATIBLE_API_KEY"] = API_KEY
 
     # Create provider without explicit parameters
     provider = OpenAICompatibleProvider()
 
     # Verify environment variables were used
     assert provider.base_url == BASE_URL
     assert provider.api_key == API_KEY
-    print(f"✅ Provider used OPENAI_COMPATIBLE_BASE_URL: {BASE_URL}")
-    print(f"✅ Provider used OPENAI_COMPATIBLE_API_KEY: {API_KEY[:10]}...")
+    print(f"✅ Provider used AXM_OPENAI_COMPATIBLE_BASE_URL: {BASE_URL}")
+    print(f"✅ Provider used AXM_OPENAI_COMPATIBLE_API_KEY: {API_KEY[:10]}...")
 
     # Create agent without explicit parameters
     agent = Agent(model=MODEL)
     assert isinstance(agent.llm, OpenAICompatibleProvider)
     assert agent.llm.base_url == BASE_URL
-    print(f"✅ Agent used environment variables correctly")
+    print("✅ Agent used environment variables correctly")
 
     print("\n✅ All environment variable tests passed!")