codex-agent-framework 0.1.46__tar.gz → 0.1.48__tar.gz

{codex_agent_framework-0.1.46 → codex_agent_framework-0.1.48}/CHANGELOG.md

@@ -4,6 +4,23 @@ All notable changes to this project will be documented in this file.
 
 This project loosely follows [Keep a Changelog](https://keepachangelog.com/en/1.1.0/) and uses semantic versioning where practical.
 
+## [0.1.48] - 2026-05-16
+### Changed
+- Make OpenAI API key validation configurable with `validate_openai_api_key` while preserving validation by default.
+- Cache successful or failed OpenAI API key validation by key fingerprint to avoid repeated `models.list()` checks across clients using the same key.
+- Update development docs for the current 556-test offline CI count.
+
+### Tests
+- Add coverage for cached OpenAI key validation and disabled validation, then validate with targeted AI/config/response coverage plus the 556-test offline CI suite.
+
+## [0.1.47] - 2026-05-16
+### Changed
+- Document the current alpha public API contract for SDK and plugin users, including preferred surfaces such as `Agent`, `AgentTurn`, decorators, `Plugin`, hooks, events, and `agent.add_*` helpers.
+- Clarify that manager internals are not the recommended extension surface for application or plugin code.
+
+### Tests
+- Validate the documentation update with the 554-test offline CI suite.
+
 ## [0.1.46] - 2026-05-16
 ### Changed
 - Clarify README product positioning as an open-source, hackable, local-first Codex-style harness with explicit control over sessions, tools, plugins, runtime state, and UI surfaces.

{codex_agent_framework-0.1.46/codex_agent_framework.egg-info → codex_agent_framework-0.1.48}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codex-agent-framework
-Version: 0.1.46
+Version: 0.1.48
 Summary: A lightweight event-driven Codex agent runtime.
 Author: Baptiste
 License-Expression: MIT

{codex_agent_framework-0.1.46 → codex_agent_framework-0.1.48}/codex_agent/ai.py

@@ -1,3 +1,4 @@
+import hashlib
 import queue
 import threading
 
@@ -61,6 +62,9 @@ MAX_EMBEDDING_INPUT_TOKENS = 7500
 class AIClient:
     """Client for Codex backend LLM/embedding/STT calls plus OpenAI-key TTS/token helpers."""
 
+    _api_key_validation_cache = {}
+    _api_key_validation_lock = threading.Lock()
+
     def __init__(self, agent):
         """Initialize AI clients from agent config.
 
@@ -74,15 +78,15 @@ class AIClient:
     @property
     def client(self):
         if self._client is None:
-            api_key=self.agent.config.get('openai_api_key') or os.getenv('OPENAI_API_KEY')
+            api_key = self.openai_api_key()
             try:
                 self._client = OpenAI(api_key=api_key, timeout=180, max_retries=3)
-                if not self.api_key_is_valid():
-                    self._client=None
-                    raise APIAuthenticationError("Missing or invalid OpenAI API key. You can pass it when creating the agent with `agent=Agent(openai_api_key='your_api_key')` or via `agent.config.openai_api_key` or set the OPENAI_API_KEY environment variable. You can get an API key at https://platform.openai.com/account/api-keys.")
+                if self.agent.config.get("validate_openai_api_key", True) and not self.api_key_is_valid(api_key):
+                    self._client = None
+                    raise self.authentication_error()
             except OpenAIError:
-                self._client=None
-                raise APIAuthenticationError("Missing or invalid OpenAI API key. You can pass it when creating the agent with `agent=Agent(openai_api_key='your_api_key')` or via `agent.config.openai_api_key` or set the OPENAI_API_KEY environment variable. You can get an API key at https://platform.openai.com/account/api-keys.")
+                self._client = None
+                raise self.authentication_error()
         return self._client
 
     @property
@@ -97,19 +101,38 @@ class AIClient:
         if self._codex_client is not None and hasattr(self._codex_client, "abort"):
             self._codex_client.abort()
 
-    def api_key_is_valid(self):
-        """
-        Verify that the API key is valid by making a minimal API call.
+    def openai_api_key(self):
+        return self.agent.config.get("openai_api_key") or os.getenv("OPENAI_API_KEY")
+
+    def authentication_error(self):
+        return APIAuthenticationError(
+            "Missing or invalid OpenAI API key. You can pass it when creating the agent with "
+            "`agent=Agent(openai_api_key='your_api_key')` or via `agent.config.openai_api_key` "
+            "or set the OPENAI_API_KEY environment variable. You can get an API key at "
+            "https://platform.openai.com/account/api-keys."
+        )
+
+    def api_key_cache_key(self, api_key):
+        return hashlib.sha256((api_key or "").encode()).hexdigest()
+
+    def api_key_is_valid(self, api_key=None):
+        """Verify the OpenAI API key once per key value."""
+        api_key = self.openai_api_key() if api_key is None else api_key
+        cache_key = self.api_key_cache_key(api_key)
+        with self._api_key_validation_lock:
+            if cache_key in self._api_key_validation_cache:
+                return self._api_key_validation_cache[cache_key]
 
-        Returns:
-            bool: True if API key is valid, False otherwise
-        """
         try:
-            # Make a minimal API call to verify the key
-            self.client.models.list()
-            return True
+            validation_client = self._client or OpenAI(api_key=api_key, timeout=180, max_retries=3)
+            validation_client.models.list()
+            valid = True
         except Exception:
-            return False
+            valid = False
+
+        with self._api_key_validation_lock:
+            self._api_key_validation_cache[cache_key] = valid
+        return valid
 
     def text_to_audio(self, model=None, voice=None, input='', voice_instructions='', **kwargs):
         """

{codex_agent_framework-0.1.46 → codex_agent_framework-0.1.48}/codex_agent/config.py

@@ -19,6 +19,7 @@ class AgentConfig(modict):
     system = DEFAULT_SYSTEM_PROMPT
     auto_proceed = True
     openai_api_key = None
+    validate_openai_api_key = True
     history = None
     name = "Pandora"
     username = "Unknown"

codex_agent_framework-0.1.48/codex_agent/version.py

@@ -0,0 +1 @@
+__version__ = "0.1.48"

{codex_agent_framework-0.1.46 → codex_agent_framework-0.1.48/codex_agent_framework.egg-info}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: codex-agent-framework
-Version: 0.1.46
+Version: 0.1.48
 Summary: A lightweight event-driven Codex agent runtime.
 Author: Baptiste
 License-Expression: MIT

{codex_agent_framework-0.1.46 → codex_agent_framework-0.1.48}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "codex-agent-framework"
-version = "0.1.46"
+version = "0.1.48"
 description = "A lightweight event-driven Codex agent runtime."
 readme = "README.md"
 requires-python = ">=3.11"

{codex_agent_framework-0.1.46 → codex_agent_framework-0.1.48}/tests/test_ai.py

@@ -84,6 +84,49 @@ class FakeAgent:
         self.mainloop_manager = FakeMainLoopManager()
 
 
+class FakeModels:
+    def __init__(self):
+        self.calls = 0
+
+    def list(self):
+        self.calls += 1
+        return []
+
+
+class FakeOpenAIValidationClient:
+    instances = []
+
+    def __init__(self, **kwargs):
+        self.kwargs = kwargs
+        self.models = FakeModels()
+        self.__class__.instances.append(self)
+
+
+def test_openai_api_key_validation_is_cached_by_key(monkeypatch):
+    AIClient._api_key_validation_cache.clear()
+    FakeOpenAIValidationClient.instances = []
+    monkeypatch.setattr("codex_agent.ai.OpenAI", FakeOpenAIValidationClient)
+
+    first = AIClient(FakeAgent(openai_api_key="sk-test"))
+    second = AIClient(FakeAgent(openai_api_key="sk-test"))
+
+    assert first.client is FakeOpenAIValidationClient.instances[0]
+    assert second.client is FakeOpenAIValidationClient.instances[1]
+    assert FakeOpenAIValidationClient.instances[0].models.calls == 1
+    assert FakeOpenAIValidationClient.instances[1].models.calls == 0
+
+
+def test_openai_api_key_validation_can_be_disabled(monkeypatch):
+    AIClient._api_key_validation_cache.clear()
+    FakeOpenAIValidationClient.instances = []
+    monkeypatch.setattr("codex_agent.ai.OpenAI", FakeOpenAIValidationClient)
+
+    ai = AIClient(FakeAgent(openai_api_key="sk-test", validate_openai_api_key=False))
+
+    assert ai.client is FakeOpenAIValidationClient.instances[0]
+    assert FakeOpenAIValidationClient.instances[0].models.calls == 0
+
+
 def test_embed_content_truncates_input_to_embedding_token_budget():
     ai = AIClient(agent=None)
     ai._codex_client = FakeCodexClient()

codex_agent_framework-0.1.46/codex_agent/version.py

@@ -1 +0,0 @@
-__version__ = "0.1.46"