agent-starter-pack 0.15.2__py3-none-any.whl → 0.15.4__py3-none-any.whl

{agent_starter_pack-0.15.2.dist-info → agent_starter_pack-0.15.4.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: agent-starter-pack
-Version: 0.15.2
+Version: 0.15.4
 Summary: CLI to bootstrap production-ready Google Cloud GenAI agent projects from templates.
 Author-email: Google LLC <agent-starter-pack@google.com>
 License: Apache-2.0

{agent_starter_pack-0.15.2.dist-info → agent_starter_pack-0.15.4.dist-info}/RECORD

@@ -71,8 +71,8 @@ src/base_template/{% if cookiecutter.cicd_runner == 'google_cloud_build' %}.clou
 src/base_template/{{cookiecutter.agent_directory}}/utils/gcs.py,sha256=jKblaWOGQEigw3esaawcfX178shhZi2Fyk0fJSA4T68,1501
 src/base_template/{{cookiecutter.agent_directory}}/utils/tracing.py,sha256=2rv1Ukh2jTBENDwoghCItJ28l-Sjz9gMlzdojlVgJa4,6052
 src/base_template/{{cookiecutter.agent_directory}}/utils/typing.py,sha256=DP5OZC3IGvqA1XbvWt8kI3gyAK3ZjzUSL5Ca17wNeLI,4249
-src/cli/main.py,sha256=Dya7Sw3ozMTaGDcwMh_-W7udkGZHGzgAj8aBdSZaZxI,1832
-src/cli/commands/create.py,sha256=R1KKf419Wd2QMi98LrVgm68OyaHKFd0rtm5P3_SIZhI,46779
+src/cli/main.py,sha256=aSD5x_r3yMqnI1Bp_HUsgpzJ7QdQNgR06TOVixVv1kU,1954
+src/cli/commands/create.py,sha256=ceUJyzdUN-h-0-7jw6gSSgQWFNXmcsDS47C7Lt8yEew,47385
 src/cli/commands/enhance.py,sha256=AF58CFikNLPib8PULKkzM6r9JGXkTvRWspBaEvGnR3k,24237
 src/cli/commands/list.py,sha256=ZGol9eYB9Yon7JysMUCtpEOwdXzrApdTHzErx6KvT04,6856
 src/cli/commands/setup_cicd.py,sha256=3BtHChOPvp0I-4tlPqwz5hZFm13gtw9gvlWQwF-F7oE,32492
@@ -97,7 +97,8 @@ src/deployment_targets/agent_engine/tests/integration/test_agent_engine_app.py,s
 src/deployment_targets/agent_engine/tests/load_test/README.md,sha256=aQP7nDAqd2jKBET4noI39HC9PVHpgpned7cxucWpVJo,1302
 src/deployment_targets/agent_engine/tests/load_test/load_test.py,sha256=VbQjm8uR8JsdJe3upO1eUIz5SZR7IQsHYyJy88cAjy0,4516
 src/deployment_targets/agent_engine/tests/load_test/.results/.placeholder,sha256=47DEQpj8HBSa-_TImW-5JCeuQeRkm5NMpJWZG3hSuFU,0
-src/deployment_targets/agent_engine/{{cookiecutter.agent_directory}}/agent_engine_app.py,sha256=cjrqlRR9ORt42Sb_snSFmNQEj6egWkJrL6l2divhmAk,12876
+src/deployment_targets/agent_engine/{{cookiecutter.agent_directory}}/agent_engine_app.py,sha256=a5QPypiAn_yJxTAEJLQwpbqJRzhP3vk21IoeIZvC0VI,12437
+src/deployment_targets/agent_engine/{{cookiecutter.agent_directory}}/utils/deployment.py,sha256=AY7awaGuFjri4Ha6M2IrPwpl1b1V7RTlJ_4uZ_zpfTo,2833
 src/deployment_targets/cloud_run/Dockerfile,sha256=rSpmFK7uJhZYwYMtxH8W7mywcCPvaoFn7gL_mXRYuF8,1449
 src/deployment_targets/cloud_run/deployment/terraform/service.tf,sha256=09F6jkkMtoQlbQNdzJl8OZs-ZlfmzZmgCaUFvniJnlQ,11146
 src/deployment_targets/cloud_run/deployment/terraform/dev/service.tf,sha256=l6fG-kMyYOOrRwnsUys_Vq46-76bMiRyXzHYkVD2XFM,6993
@@ -168,8 +169,8 @@ src/resources/locks/uv-live_api-cloud_run.lock,sha256=jrcrlnpJfJ6MIyEz1Z7qS_nxy0
 src/utils/generate_locks.py,sha256=6V1B8V2BEuevWnXUsxZVTrLjXwFRII8UfsIGrQqZxVs,4320
 src/utils/lock_utils.py,sha256=IFOMUWtb-ypm2Y8w8J5y2oI_-MaPuwPF_JOAAlnNudA,2275
 src/utils/watch_and_rebuild.py,sha256=vP4yIiA7E_lj5sfQdJUl8TXas6V7msDg8XWUutAC05Q,6679
-agent_starter_pack-0.15.2.dist-info/METADATA,sha256=ugrm2WVZ76bwlX4PT7tvySGXcFITiFHzauYm-IQP1Pw,11482
-agent_starter_pack-0.15.2.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-agent_starter_pack-0.15.2.dist-info/entry_points.txt,sha256=U7uCxR7YulIhZ0L8R8Hui0Bsy6J7oyESBeDYJYMrQjA,56
-agent_starter_pack-0.15.2.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-agent_starter_pack-0.15.2.dist-info/RECORD,,
+agent_starter_pack-0.15.4.dist-info/METADATA,sha256=oy_pKDCsfQynZ1vnr9LvdqmyOI8QE0DqvWsTOu3Trnw,11482
+agent_starter_pack-0.15.4.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+agent_starter_pack-0.15.4.dist-info/entry_points.txt,sha256=U7uCxR7YulIhZ0L8R8Hui0Bsy6J7oyESBeDYJYMrQjA,56
+agent_starter_pack-0.15.4.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+agent_starter_pack-0.15.4.dist-info/RECORD,,

src/cli/commands/create.py

@@ -630,12 +630,13 @@ def create(
         # CI/CD runner selection
         final_cicd_runner = cicd_runner
         if not final_cicd_runner:
-            if auto_approve:
+            if auto_approve or agent_garden:
                 final_cicd_runner = "google_cloud_build"
-                console.print(
-                    "Info: --cicd-runner not specified. Defaulting to 'google_cloud_build' in auto-approve mode.",
-                    style="yellow",
-                )
+                if not agent_garden:
+                    console.print(
+                        "Info: --cicd-runner not specified. Defaulting to 'google_cloud_build' in auto-approve mode.",
+                        style="yellow",
+                    )
             else:
                 final_cicd_runner = prompt_cicd_runner_selection()
         if debug:
@@ -646,7 +647,13 @@ def create(
             not auto_approve
             and ctx.get_parameter_source("region") != ParameterSource.COMMANDLINE
         ):
-            region = prompt_region_confirmation(region)
+            # Show Agent Engine supported regions link if agent_garden flag is set
+            if agent_garden:
+                console.print(
+                    "\n📍 [blue]Agent Engine Supported Regions:[/blue]\n"
+                    "   [cyan]https://cloud.google.com/vertex-ai/generative-ai/docs/agent-engine/overview#supported-regions[/cyan]"
+                )
+            region = prompt_region_confirmation(region, agent_garden=agent_garden)
         if debug:
             logging.debug(f"Selected region: {region}")
 
@@ -777,7 +784,9 @@ def create(
         raise
 
 
-def prompt_region_confirmation(default_region: str = "us-central1") -> str:
+def prompt_region_confirmation(
+    default_region: str = "us-central1", agent_garden: bool = False
+) -> str:
     """Prompt user to confirm or change the default region."""
     new_region = Prompt.ask(
         "\nEnter desired GCP region (Gemini uses global endpoint by default)",
@@ -965,7 +974,8 @@ def setup_gcp_environment(
         logging.debug("Verifying GCP credentials...")
     creds_info = verify_credentials()
     # Handle credential verification and project selection
-    if not auto_approve:
+    # Skip interactive prompts if auto_approve or agent_garden is set
+    if not auto_approve and not agent_garden:
         creds_info = _handle_credential_verification(creds_info)
         # If user chose to skip verification, don't test Vertex AI connection
         if creds_info.get("skip_vertex_test", False):
@@ -976,7 +986,7 @@ def setup_gcp_environment(
                 creds_info["project"], region, agent_garden=agent_garden
             )
     else:
-        # Even with auto_approve, we should still set the GCP project
+        # Even with auto_approve or agent_garden, we should still set the GCP project
         set_gcp_project(creds_info["project"], set_quota_project=True)
         # Test Vertex AI connection
         _test_vertex_ai_connection(

src/cli/main.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 import importlib.metadata
+import sys
 
 import click
 from rich.console import Console
@@ -48,8 +49,9 @@ def print_version(ctx: click.Context, param: click.Parameter, value: bool) -> No
     help="Show the version and exit.",
 )
 def cli() -> None:
-    # Check for updates at startup
-    display_update_message()
+    # Check for updates at startup (skip if --agent-garden or -ag is used)
+    if "--agent-garden" not in sys.argv and "-ag" not in sys.argv:
+        display_update_message()
 
 
 # Register commands

src/deployment_targets/agent_engine/{{cookiecutter.agent_directory}}/agent_engine_app.py

@@ -14,12 +14,11 @@
 
 # mypy: disable-error-code="attr-defined,arg-type"
 {%- if "adk" in cookiecutter.tags %}
-import datetime
-import json
 import logging
 import os
 from typing import Any
 
+import click
 import google.auth
 import vertexai
 from google.adk.artifacts import GcsArtifactService
@@ -30,6 +29,11 @@ from vertexai._genai.types import AgentEngine, AgentEngineConfig
 from vertexai.agent_engines.templates.adk import AdkApp
 
 from {{cookiecutter.agent_directory}}.agent import root_agent
+from {{cookiecutter.agent_directory}}.utils.deployment import (
+    parse_env_vars,
+    print_deployment_success,
+    write_deployment_metadata,
+)
 from {{cookiecutter.agent_directory}}.utils.gcs import create_bucket_if_not_exists
 from {{cookiecutter.agent_directory}}.utils.tracing import CloudTraceLoggingSpanExporter
 from {{cookiecutter.agent_directory}}.utils.typing import Feedback
@@ -68,8 +72,6 @@ class AgentEngineApp(AdkApp):
         return operations
 
 {%- else %}
-import datetime
-import json
 import logging
 import os
 from collections.abc import Iterable, Mapping
@@ -77,6 +79,7 @@ from typing import (
     Any,
 )
 
+import click
 import google.auth
 import vertexai
 from google.cloud import logging as google_cloud_logging
@@ -84,6 +87,11 @@ from langchain_core.runnables import RunnableConfig
 from traceloop.sdk import Instruments, Traceloop
 from vertexai._genai.types import AgentEngine, AgentEngineConfig
 
+from {{cookiecutter.agent_directory}}.utils.deployment import (
+    parse_env_vars,
+    print_deployment_success,
+    write_deployment_metadata,
+)
 from {{cookiecutter.agent_directory}}.utils.gcs import create_bucket_if_not_exists
 from {{cookiecutter.agent_directory}}.utils.tracing import CloudTraceLoggingSpanExporter
 from {{cookiecutter.agent_directory}}.utils.typing import Feedback, InputChat, dumpd, ensure_valid_config
@@ -190,17 +198,69 @@ class AgentEngineApp:
 {%- endif %}
 
 
+@click.command()
+@click.option(
+    "--project",
+    default=None,
+    help="GCP project ID (defaults to application default credentials)",
+)
+@click.option(
+    "--location",
+    default="us-central1",
+    help="GCP region (defaults to us-central1)",
+)
+@click.option(
+    "--agent-name",
+    default="{{cookiecutter.project_name}}",
+    help="Name for the agent engine",
+)
+@click.option(
+    "--requirements-file",
+    default=".requirements.txt",
+    help="Path to requirements.txt file",
+)
+@click.option(
+    "--extra-packages",
+    multiple=True,
+    default=["./{{cookiecutter.agent_directory}}"],
+    help="Additional packages to include",
+)
+@click.option(
+    "--set-env-vars",
+    default=None,
+    help="Comma-separated list of environment variables in KEY=VALUE format",
+)
+@click.option(
+    "--service-account",
+    default=None,
+    help="Service account email to use for the agent engine",
+)
 def deploy_agent_engine_app(
-    project: str,
+    project: str | None,
     location: str,
-    agent_name: str | None = None,
-    requirements_file: str = ".requirements.txt",
-    extra_packages: list[str] = ["./{{cookiecutter.agent_directory}}"],
-    env_vars: dict[str, str] = {},
-    service_account: str | None = None,
+    agent_name: str,
+    requirements_file: str,
+    extra_packages: tuple[str, ...],
+    set_env_vars: str | None,
+    service_account: str | None,
 ) -> AgentEngine:
     """Deploy the agent engine app to Vertex AI."""
+    # Parse environment variables if provided
+    env_vars = parse_env_vars(set_env_vars)
+
+    if not project:
+        _, project = google.auth.default()
+
+    print("""
+    ╔═══════════════════════════════════════════════════════════╗
+    ║                                                           ║
+    ║   🤖 DEPLOYING AGENT TO VERTEX AI AGENT ENGINE 🤖         ║
+    ║                                                           ║
+    ╚═══════════════════════════════════════════════════════════╝
+    """)
+
     logging.basicConfig(level=logging.INFO)
+    extra_packages_list = list(extra_packages)
     staging_bucket_uri = f"gs://{project}-agent-engine"
 {%- if "adk" in cookiecutter.tags %}
     artifacts_bucket_name = f"{project}-{{cookiecutter.project_name}}-logs-data"
@@ -236,14 +296,24 @@ def deploy_agent_engine_app(
     env_vars["NUM_WORKERS"] = "1"
 
     # Common configuration for both create and update operations
+    labels: dict[str, str] = {}
+{%- if cookiecutter.agent_garden %}
+    labels["deployed-with"] = "agent-garden"
+{%- if cookiecutter.agent_sample_id and cookiecutter.agent_sample_publisher %}
+    labels["vertex-agent-sample-id"] = "{{cookiecutter.agent_sample_id}}"
+    labels["vertex-agent-sample-publisher"] = "{{cookiecutter.agent_sample_publisher}}"
+{%- endif %}
+{%- endif %}
+
     config = AgentEngineConfig(
         display_name=agent_name,
         description="{{cookiecutter.agent_description}}",
-        extra_packages=extra_packages,
+        extra_packages=extra_packages_list,
         env_vars=env_vars,
         service_account=service_account,
         requirements=requirements,
         staging_bucket=staging_bucket_uri,
+        labels=labels,
     )
 
     agent_config = {
@@ -262,100 +332,20 @@ def deploy_agent_engine_app(
 
     if matching_agents:
         # Update the existing agent with new configuration
-        logging.info(f"Updating existing agent: {agent_name}")
+        logging.info(f"\n📝 Updating existing agent: {agent_name}")
         remote_agent = client.agent_engines.update(
             name=matching_agents[0].api_resource.name, **agent_config
         )
     else:
         # Create a new agent if none exists
-        logging.info(f"Creating new agent: {agent_name}")
+        logging.info(f"\n🚀 Creating new agent: {agent_name}")
         remote_agent = client.agent_engines.create(**agent_config)
 
-    metadata = {
-        "remote_agent_engine_id": remote_agent.api_resource.name,
-        "deployment_timestamp": datetime.datetime.now().isoformat(),
-    }
-    metadata_file = "deployment_metadata.json"
-
-    with open(metadata_file, "w") as f:
-        json.dump(metadata, f, indent=2)
-
-    logging.info(f"Agent Engine ID written to {metadata_file}")
-
-{%- if "adk" in cookiecutter.tags %}
-    print(
-        "\n✅ Deployment successful! Test your agent: notebooks/adk_app_testing.ipynb\n"
-    )
-{%- endif %}
+    write_deployment_metadata(remote_agent)
+    print_deployment_success(remote_agent, location, project)
 
     return remote_agent
 
 
 if __name__ == "__main__":
-    import argparse
-
-    parser = argparse.ArgumentParser(description="Deploy agent engine app to Vertex AI")
-    parser.add_argument(
-        "--project",
-        default=None,
-        help="GCP project ID (defaults to application default credentials)",
-    )
-    parser.add_argument(
-        "--location",
-        default="us-central1",
-        help="GCP region (defaults to us-central1)",
-    )
-    parser.add_argument(
-        "--agent-name",
-        default="{{cookiecutter.project_name}}",
-        help="Name for the agent engine",
-    )
-    parser.add_argument(
-        "--requirements-file",
-        default=".requirements.txt",
-        help="Path to requirements.txt file",
-    )
-    parser.add_argument(
-        "--extra-packages",
-        nargs="+",
-        default=["./{{cookiecutter.agent_directory}}"],
-        help="Additional packages to include",
-    )
-    parser.add_argument(
-        "--set-env-vars",
-        help="Comma-separated list of environment variables in KEY=VALUE format",
-    )
-    parser.add_argument(
-        "--service-account",
-        default=None,
-        help="Service account email to use for the agent engine",
-    )
-    args = parser.parse_args()
-
-    # Parse environment variables if provided
-    env_vars = {}
-    if args.set_env_vars:
-        for pair in args.set_env_vars.split(","):
-            key, value = pair.split("=", 1)
-            env_vars[key] = value
-
-    if not args.project:
-        _, args.project = google.auth.default()
-
-    print("""
-    ╔═══════════════════════════════════════════════════════════╗
-    ║                                                           ║
-    ║   🤖 DEPLOYING AGENT TO VERTEX AI AGENT ENGINE 🤖         ║
-    ║                                                           ║
-    ╚═══════════════════════════════════════════════════════════╝
-    """)
-
-    deploy_agent_engine_app(
-        project=args.project,
-        location=args.location,
-        agent_name=args.agent_name,
-        requirements_file=args.requirements_file,
-        extra_packages=args.extra_packages,
-        env_vars=env_vars,
-        service_account=args.service_account,
-    )
+    deploy_agent_engine_app()

src/deployment_targets/agent_engine/{{cookiecutter.agent_directory}}/utils/deployment.py

@@ -0,0 +1,85 @@
+# 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.
+
+import datetime
+import json
+import logging
+from typing import Any
+
+
+def parse_env_vars(env_vars_string: str | None) -> dict[str, str]:
+    """Parse environment variables from a comma-separated KEY=VALUE string.
+
+    Args:
+        env_vars_string: Comma-separated list of environment variables in KEY=VALUE format
+
+    Returns:
+        Dictionary of environment variables with keys and values stripped of whitespace
+    """
+    env_vars = {}
+    if env_vars_string:
+        for pair in env_vars_string.split(","):
+            if "=" in pair:
+                key, value = pair.split("=", 1)
+                env_vars[key.strip()] = value.strip()
+            else:
+                logging.warning(f"Skipping malformed environment variable pair: {pair}")
+    return env_vars
+
+
+def write_deployment_metadata(
+    remote_agent: Any,
+    metadata_file: str = "deployment_metadata.json",
+) -> None:
+    """Write deployment metadata to file.
+
+    Args:
+        remote_agent: The deployed agent engine resource
+        metadata_file: Path to write the metadata JSON file
+    """
+    metadata = {
+        "remote_agent_engine_id": remote_agent.api_resource.name,
+        "deployment_timestamp": datetime.datetime.now().isoformat(),
+    }
+
+    with open(metadata_file, "w") as f:
+        json.dump(metadata, f, indent=2)
+
+    logging.info(f"Agent Engine ID written to {metadata_file}")
+
+
+def print_deployment_success(
+    remote_agent: Any,
+    location: str,
+    project: str,
+) -> None:
+    """Print deployment success message with console URL.
+
+    Args:
+        remote_agent: The deployed agent engine resource
+        location: GCP region where the agent was deployed
+        project: GCP project ID
+    """
+    # Extract agent engine ID for console URL
+    agent_engine_id = remote_agent.api_resource.name.split("/")[-1]
+    console_url = f"https://console.cloud.google.com/vertex-ai/agents/locations/{location}/agent-engines/{agent_engine_id}?project={project}"
+
+{%- if "adk" in cookiecutter.tags %}
+    print(
+        f"\n✅ Deployment successful! Test your agent: notebooks/adk_app_testing.ipynb"
+        f"\n📊 View in console: {console_url}\n"
+    )
+{%- else %}
+    print(f"\n✅ Deployment successful!\n📊 View in console: {console_url}\n")
+{%- endif %}