google-adk 0.0.2__py3-none-any.whl → 0.0.3__py3-none-any.whl

google/adk/cli/cli_tools_click.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 import asyncio
+from contextlib import asynccontextmanager
 from datetime import datetime
 import logging
 import os
@@ -20,6 +21,7 @@ import tempfile
 from typing import Optional
 
 import click
+from fastapi import FastAPI
 import uvicorn
 
 from . import cli_deploy
@@ -230,6 +232,13 @@ def eval_command(
         " This is useful for local debugging."
     ),
 )
+@click.option(
+    "--trace_to_cloud",
+    is_flag=True,
+    show_default=True,
+    default=False,
+    help="Optional. Whether to enable cloud trace for telemetry.",
+)
 @click.argument(
     "agents_dir",
     type=click.Path(
@@ -244,6 +253,7 @@ def web(
     log_level: str = "INFO",
     allow_origins: Optional[list[str]] = None,
     port: int = 8000,
+    trace_to_cloud: bool = False,
 ):
   """Start a FastAPI server with web UI for a certain agent.
 
@@ -261,17 +271,43 @@ def web(
 
   logging.getLogger().setLevel(log_level)
 
+  @asynccontextmanager
+  async def _lifespan(app: FastAPI):
+    click.secho(
+        f"""\
++-----------------------------------------------------------------------------+
+| ADK Web Server started                                                      |
+|                                                                             |
+| For local testing, access at http://localhost:{port}.{" "*(29 - len(str(port)))}|
++-----------------------------------------------------------------------------+
+""",
+        fg="green",
+    )
+    yield  # Startup is done, now app is running
+    click.secho(
+        """\
++-----------------------------------------------------------------------------+
+| ADK Web Server shutting down...                                             |
++-----------------------------------------------------------------------------+
+""",
+        fg="green",
+    )
+
+  app = get_fast_api_app(
+      agent_dir=agents_dir,
+      session_db_url=session_db_url,
+      allow_origins=allow_origins,
+      web=True,
+      trace_to_cloud=trace_to_cloud,
+      lifespan=_lifespan,
+  )
   config = uvicorn.Config(
-      get_fast_api_app(
-          agent_dir=agents_dir,
-          session_db_url=session_db_url,
-          allow_origins=allow_origins,
-          web=True,
-      ),
+      app,
       host="0.0.0.0",
       port=port,
       reload=True,
   )
+
   server = uvicorn.Server(config)
   server.run()
 
@@ -317,6 +353,13 @@ def web(
         " This is useful for local debugging."
     ),
 )
+@click.option(
+    "--trace_to_cloud",
+    is_flag=True,
+    show_default=True,
+    default=False,
+    help="Optional. Whether to enable cloud trace for telemetry.",
+)
 # The directory of agents, where each sub-directory is a single agent.
 # By default, it is the current working directory
 @click.argument(
@@ -333,6 +376,7 @@ def cli_api_server(
     log_level: str = "INFO",
     allow_origins: Optional[list[str]] = None,
     port: int = 8000,
+    trace_to_cloud: bool = False,
 ):
   """Start an api server for a certain agent.
 
@@ -356,6 +400,7 @@ def cli_api_server(
           session_db_url=session_db_url,
           allow_origins=allow_origins,
           web=False,
+          trace_to_cloud=trace_to_cloud,
       ),
       host="0.0.0.0",
       port=port,

google/adk/cli/fast_api.py

@@ -31,7 +31,6 @@ import click
 from fastapi import FastAPI
 from fastapi import HTTPException
 from fastapi import Query
-from fastapi import Response
 from fastapi.middleware.cors import CORSMiddleware
 from fastapi.responses import FileResponse
 from fastapi.responses import RedirectResponse
@@ -48,6 +47,7 @@ from opentelemetry.sdk.trace import ReadableSpan
 from opentelemetry.sdk.trace import TracerProvider
 from pydantic import BaseModel
 from pydantic import ValidationError
+from starlette.types import Lifespan
 
 from ..agents import RunConfig
 from ..agents.live_request_queue import LiveRequest
@@ -132,6 +132,8 @@ def get_fast_api_app(
     session_db_url: str = "",
     allow_origins: Optional[list[str]] = None,
     web: bool,
+    trace_to_cloud: bool = False,
+    lifespan: Optional[Lifespan[FastAPI]] = None,
 ) -> FastAPI:
   # InMemory tracing dict.
   trace_dict: dict[str, Any] = {}
@@ -141,18 +143,26 @@ def get_fast_api_app(
   provider.add_span_processor(
       export.SimpleSpanProcessor(ApiServerSpanExporter(trace_dict))
   )
-  if os.environ.get("ADK_TRACE_TO_CLOUD", "0") == "1":
-    processor = export.BatchSpanProcessor(
-        CloudTraceSpanExporter(
-            project_id=os.environ.get("GOOGLE_CLOUD_PROJECT", "")
-        )
-    )
-    provider.add_span_processor(processor)
+  envs.load_dotenv()
+  enable_cloud_tracing = trace_to_cloud or os.environ.get(
+      "ADK_TRACE_TO_CLOUD", "0"
+  ).lower() in ["1", "true"]
+  if enable_cloud_tracing:
+    if project_id := os.environ.get("GOOGLE_CLOUD_PROJECT", None):
+      processor = export.BatchSpanProcessor(
+          CloudTraceSpanExporter(project_id=project_id)
+      )
+      provider.add_span_processor(processor)
+    else:
+      logging.warning(
+          "GOOGLE_CLOUD_PROJECT environment variable is not set. Tracing will"
+          " not be enabled."
+      )
 
   trace.set_tracer_provider(provider)
 
   # Run the FastAPI server.
-  app = FastAPI()
+  app = FastAPI(lifespan=lifespan)
 
   if allow_origins:
     app.add_middleware(

google/adk/docs/Makefile

@@ -0,0 +1,20 @@
+# Minimal makefile for Sphinx documentation
+#
+
+# You can set these variables from the command line, and also
+# from the environment for the first two.
+SPHINXOPTS    ?=
+SPHINXBUILD   ?= sphinx-build
+SOURCEDIR     = source
+BUILDDIR      = build
+
+# Put it first so that "make" without argument is like "make help".
+help:
+	@$(SPHINXBUILD) -M help "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)
+
+.PHONY: help Makefile
+
+# Catch-all target: route all unknown targets to Sphinx using the new
+# "make mode" option.  $(O) is meant as a shortcut for $(SPHINXOPTS).
+%: Makefile
+	@$(SPHINXBUILD) -M $@ "$(SOURCEDIR)" "$(BUILDDIR)" $(SPHINXOPTS) $(O)

google/adk/docs/build/html/_sources/google-adk.rst.txt

@@ -0,0 +1,98 @@
+Submodules
+----------
+
+google.adk.agents module
+------------------------
+
+.. automodule:: google.adk.agents
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+google.adk.artifacts module
+---------------------------
+
+.. automodule:: google.adk.artifacts
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+google.adk.code_executors module
+--------------------------------
+
+.. automodule:: google.adk.code_executors
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+google.adk.evaluation module
+----------------------------
+
+.. automodule:: google.adk.evaluation
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+google.adk.events module
+------------------------
+
+.. automodule:: google.adk.events
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+google.adk.examples module
+--------------------------
+
+.. automodule:: google.adk.examples
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+google.adk.memory module
+------------------------
+
+.. automodule:: google.adk.memory
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+google.adk.models module
+------------------------
+
+.. automodule:: google.adk.models
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+google.adk.planners module
+--------------------------
+
+.. automodule:: google.adk.planners
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+google.adk.runners module
+--------------------------
+
+.. automodule:: google.adk.runners
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+google.adk.sessions module
+--------------------------
+
+.. automodule:: google.adk.sessions
+    :members:
+    :undoc-members:
+    :show-inheritance:
+
+google.adk.tools module
+-----------------------
+
+.. automodule:: google.adk.tools
+    :members:
+    :undoc-members:
+    :show-inheritance:

google/adk/docs/build/html/_sources/index.rst.txt

@@ -0,0 +1,7 @@
+google
+======
+
+.. toctree::
+   :maxdepth: 4
+
+   google-adk

google/adk/docs/build/html/_static/autodoc_pydantic.css

@@ -0,0 +1,27 @@
+/**
+ * Copyright 2025 Google LLC
+ *
+ * Licensed under the Apache License, Version 2.0 (the "License");
+ * you may not use this file except in compliance with the License.
+ * You may obtain a copy of the License at
+ *
+ *     http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+
+.autodoc_pydantic_validator_arrow {
+  padding-left: 8px;
+  }
+
+.autodoc_pydantic_collapsable_json {
+  cursor: pointer;
+  }
+
+.autodoc_pydantic_collapsable_erd {
+  cursor: pointer;
+  }