Add default for GriptapeCloudEventListenerDriver.api_key (#990)

.github/workflows/docs-integration-tests.yml

@@ -72,6 +72,7 @@ jobs:
       GOOGLE_AUTH_URI: ${{ secrets.INTEG_GOOGLE_AUTH_URI }}
       GOOGLE_TOKEN_URI: ${{ secrets.INTEG_GOOGLE_TOKEN_URI }}
       GOOGLE_AUTH_PROVIDER_X509_CERT_URL: ${{ secrets.INTEG_GOOGLE_AUTH_PROVIDER_X509_CERT_URL }}
+      GT_CLOUD_API_KEY: ${{ secrets.INTEG_GRIPTAPE_CLOUD_API_KEY }}
       GRIPTAPE_CLOUD_API_KEY: ${{ secrets.INTEG_GRIPTAPE_CLOUD_API_KEY }}
       GRIPTAPE_CLOUD_STRUCTURE_ID: ${{ secrets.INTEG_GRIPTAPE_CLOUD_STRUCTURE_ID }}
       GRIPTAPE_CLOUD_BASE_URL: ${{ secrets.INTEG_GRIPTAPE_CLOUD_BASE_URL }}

CHANGELOG.md

@@ -9,6 +9,7 @@ and this project adheres to [Semantic Versioning](https://semver.org/spec/v2.0.0
 - Native function calling support to `OpenAiChatPromptDriver`, `AzureOpenAiChatPromptDriver`, `AnthropicPromptDriver`, `AmazonBedrockPromptDriver`, `GooglePromptDriver`, and `CoherePromptDriver`.
 - `OllamaEmbeddingDriver` for generating embeddings with Ollama.
 - `GriptapeCloudKnowledgeBaseVectorStoreDriver` to query Griptape Cloud Knowledge Bases.
+- `GriptapeCloudEventListenerDriver.api_key` defaults to the value in the `GT_CLOUD_API_KEY` environment variable.
 
 ### Changed
 - **BREAKING**: `BaseVectorStoreDriver.upsert_text_artifacts` optional arguments are now keyword-only arguments.

docs/griptape-framework/drivers/event-listener-drivers.md

@@ -50,9 +50,9 @@ from griptape.drivers import GriptapeCloudEventListenerDriver
 from griptape.events import FinishStructureRunEvent
 from griptape.artifacts import TextArtifact
 
-event_driver = GriptapeCloudEventListenerDriver(
-    api_key=os.environ["GRIPTAPE_CLOUD_API_KEY"]
-)
+# By default, GriptapeCloudEventListenerDriver uses the api key provided
+# in the GT_CLOUD_API_KEY environment variable.
+event_driver = GriptapeCloudEventListenerDriver()  
 
 done_event = FinishStructureRunEvent(
     output_task_input=TextArtifact("Just started!"),
@@ -173,9 +173,9 @@ agent = Agent(
     event_listeners=[
         EventListener(
             event_types=[FinishStructureRunEvent],
-            driver=GriptapeCloudEventListenerDriver(
-                api_key=os.environ["GRIPTAPE_CLOUD_API_KEY"],
-            ),
+            # By default, GriptapeCloudEventListenerDriver uses the api key provided
+            # in the GT_CLOUD_API_KEY environment variable.
+            driver=GriptapeCloudEventListenerDriver(),
         ),
     ],
 )

griptape/drivers/event_listener/griptape_cloud_event_listener_driver.py

@@ -24,7 +24,7 @@ class GriptapeCloudEventListenerDriver(BaseEventListenerDriver):
         default=Factory(lambda: os.getenv("GT_CLOUD_BASE_URL", "https://cloud.griptape.ai")),
         kw_only=True,
     )
-    api_key: str = field(kw_only=True)
+    api_key: str = field(default=Factory(lambda: os.getenv("GT_CLOUD_API_KEY")), kw_only=True)
     headers: dict = field(
         default=Factory(lambda self: {"Authorization": f"Bearer {self.api_key}"}, takes_self=True),
         kw_only=True,

griptape/tools/calculator/tool.py

@@ -21,7 +21,7 @@ class Calculator(BaseTool):
         },
     )
     def calculate(self, params: dict) -> BaseArtifact:
-        import numexpr
+        import numexpr  # pyright: ignore[reportMissingImports]
 
         try:
             expression = params["values"]["expression"]

tests/unit/drivers/event_listener/test_griptape_cloud_event_listener_driver.py

@@ -19,9 +19,23 @@ def mock_post(self, mocker):
 
     @pytest.fixture()
     def driver(self):
-        os.environ["GT_CLOUD_BASE_URL"] = "https://cloud123.griptape.ai"
+        environ = {
+            "GT_CLOUD_BASE_URL": "https://cloud123.griptape.ai",
+            "GT_CLOUD_API_KEY": "foo bar",
+            "GT_CLOUD_STRUCTURE_RUN_ID": "bar baz",
+        }
+        original_environ = {}
+        for key, value in environ.items():
+            original_environ[key] = os.environ.get(key)
+            os.environ[key] = value
 
-        return GriptapeCloudEventListenerDriver(api_key="foo bar", structure_run_id="bar baz")
+        yield GriptapeCloudEventListenerDriver()
+
+        for key, value in original_environ.items():
+            if value is None:
+                del os.environ[key]
+            else:
+                os.environ[key] = value
 
     def test_init(self, driver):
         assert driver