agent-starter-pack 0.3.4__tar.gz → 0.3.5__tar.gz

{agent_starter_pack-0.3.4 → agent_starter_pack-0.3.5}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: agent-starter-pack
-Version: 0.3.4
+Version: 0.3.5
 Summary: CLI tool to create GCP-based AI agent projects from templates
 Author-email: Google LLC <agent-starter-pack@google.com>
 License: Apache-2.0
@@ -25,7 +25,7 @@ Description-Content-Type: text/markdown
 
 # 🚀 Agent Starter Pack
 
-![Version](https://img.shields.io/pypi/v/agent-starter-pack?color=blue) [![1-Minute Video Overview](https://img.shields.io/badge/1--Minute%20Overview-gray)](https://youtu.be/jHt-ZVD660g) [![Docs](https://img.shields.io/badge/Documentation-gray)](./docs/README.md) <a href="https://studio.firebase.google.com/new?template=https%3A%2F%2Fgithub.com%2FGoogleCloudPlatform%2Fagent-starter-pack%2Ftree%2Ffeat-add-firebase-studio-resources%2Fsrc%2Fresources%2Fidx">
+![Version](https://img.shields.io/pypi/v/agent-starter-pack?color=blue) [![1-Minute Video Overview](https://img.shields.io/badge/1--Minute%20Overview-gray)](https://youtu.be/jHt-ZVD660g) [![Docs](https://img.shields.io/badge/Documentation-gray)](./docs/README.md) <a href="https://studio.firebase.google.com/new?template=https%3A%2F%2Fgithub.com%2FGoogleCloudPlatform%2Fagent-starter-pack%2Ftree%2Fmain%2Fsrc%2Fresources%2Fidx">
   <picture>
     <source
       media="(prefers-color-scheme: dark)"

{agent_starter_pack-0.3.4 → agent_starter_pack-0.3.5}/README.md

@@ -1,6 +1,6 @@
 # 🚀 Agent Starter Pack
 
-![Version](https://img.shields.io/pypi/v/agent-starter-pack?color=blue) [![1-Minute Video Overview](https://img.shields.io/badge/1--Minute%20Overview-gray)](https://youtu.be/jHt-ZVD660g) [![Docs](https://img.shields.io/badge/Documentation-gray)](./docs/README.md) <a href="https://studio.firebase.google.com/new?template=https%3A%2F%2Fgithub.com%2FGoogleCloudPlatform%2Fagent-starter-pack%2Ftree%2Ffeat-add-firebase-studio-resources%2Fsrc%2Fresources%2Fidx">
+![Version](https://img.shields.io/pypi/v/agent-starter-pack?color=blue) [![1-Minute Video Overview](https://img.shields.io/badge/1--Minute%20Overview-gray)](https://youtu.be/jHt-ZVD660g) [![Docs](https://img.shields.io/badge/Documentation-gray)](./docs/README.md) <a href="https://studio.firebase.google.com/new?template=https%3A%2F%2Fgithub.com%2FGoogleCloudPlatform%2Fagent-starter-pack%2Ftree%2Fmain%2Fsrc%2Fresources%2Fidx">
   <picture>
     <source
       media="(prefers-color-scheme: dark)"

{agent_starter_pack-0.3.4 → agent_starter_pack-0.3.5}/agents/adk_base/template/.templateconfig.yaml

@@ -16,6 +16,6 @@ description: "A base ReAct agent built with Google's Agent Development Kit (ADK)
 settings:
   requires_data_ingestion: false
   deployment_targets: ["agent_engine", "cloud_run"]
-  extra_dependencies: ["google-adk~=0.1.0"]
+  extra_dependencies: ["google-adk~=0.2.0"]
   tags: ["adk"]
   frontend_type: "None"

{agent_starter_pack-0.3.4 → agent_starter_pack-0.3.5}/docs/deployment.md

@@ -96,4 +96,31 @@ After completing these steps, your infrastructure will be set up and ready for d
 
 For End-to-end testing of the application, including tracing and feedback sinking to BigQuery, without the need to trigger a CI/CD pipeline.
 
+
 First, enable required Google Cloud APIs:
+
+```bash
+gcloud config set project <your-dev-project-id>
+gcloud services enable serviceusage.googleapis.com cloudresourcemanager.googleapis.com
+```
+After you have edited the relative env.tfvars file, located in <your-project-name>/terraform/dev/vars/env.tfvars, run the command:
+
+```bash
+cd deployment/terraform/dev
+terraform init
+terraform apply --var-file vars/env.tfvars
+```
+
+Then deploy the application using the following command (from the root of the repository):
+
+```bash
+make backend
+```
+
+> Note: the Makefile also offers a command to automate the dev terraform apply setup. `make setup-dev-env`
+
+### End-to-end Demo video
+
+<a href="https://storage.googleapis.com/github-repo/generative-ai/sample-apps/e2e-gen-ai-app-starter-pack/template_deployment_demo.mp4">
+  <img src="https://storage.googleapis.com/github-repo/generative-ai/sample-apps/e2e-gen-ai-app-starter-pack/preview_video.png" alt="Watch the video" width="300"/>
+</a>

{agent_starter_pack-0.3.4 → agent_starter_pack-0.3.5}/pyproject.toml

@@ -1,6 +1,6 @@
 [project]
 name = "agent-starter-pack"
-version = "0.3.4"
+version = "0.3.5"
 description = "CLI tool to create GCP-based AI agent projects from templates"
 authors = [
     { name = "Google LLC", email = "agent-starter-pack@google.com" },

{agent_starter_pack-0.3.4 → agent_starter_pack-0.3.5}/src/base_template/Makefile

@@ -7,12 +7,12 @@ test:
 
 playground:
 {%- if "adk" in cookiecutter.tags %}
-	@echo "+-----------------------------------------------------------------------------+"
-	@echo "| Starting ADK Web Server via 'adk web' command.                              |"
-	@echo "|                                                                             |"
-	@echo "| Please select the app folder to start interacting with your agent.          |"
-	@echo "+-----------------------------------------------------------------------------+"
-	uv run adk web
+	@echo "\033[1;32m===============================================================================\033[0m"
+	@echo "\033[1;32m| Starting ADK Web Server via 'adk web' command.                              |\033[0m"
+	@echo "\033[1;32m|                                                                             |\033[0m"
+	@echo "\033[1;32m| IMPORTANT: Select the 'app' folder to interact with your agent.             |\033[0m"
+	@echo "\033[1;32m===============================================================================\033[0m"
+	uv run adk web --port 8501
 {%- else %}
 {%- if cookiecutter.deployment_target == 'cloud_run' %}
 	uv run uvicorn app.server:app --host 0.0.0.0 --port 8000 --reload &
@@ -26,29 +26,42 @@ playground:
 
 backend:
 {%- if cookiecutter.deployment_target == 'cloud_run' %}
-	uv run uvicorn app.server:app --host 0.0.0.0 --port 8000 --reload
+	PROJECT_ID=$$(gcloud config get-value project) && \
+	gcloud run deploy {{cookiecutter.project_name}} \
+		--source . \
+		--memory "4Gi" \
+		--project $$PROJECT_ID \
+		--region "us-central1" \
+		--no-allow-unauthenticated \
+		--labels "created-by=adk" \
+		--set-env-vars \
+		"COMMIT_SHA=$(shell git rev-parse HEAD){%- if cookiecutter.data_ingestion %}{%- if cookiecutter.datastore_type == "vertex_ai_search" %},DATA_STORE_ID={{cookiecutter.project_name}}-datastore,DATA_STORE_REGION=us{%- elif cookiecutter.datastore_type == "vertex_ai_vector_search" %},VECTOR_SEARCH_INDEX={{cookiecutter.project_name}}-vector-search,VECTOR_SEARCH_INDEX_ENDPOINT={{cookiecutter.project_name}}-vector-search-endpoint,VECTOR_SEARCH_BUCKET=$$PROJECT_ID-{{cookiecutter.project_name}}-vs{%- endif %}{%- endif %}"
 {%- elif cookiecutter.deployment_target == 'agent_engine' %}
-	# Export dependencies to requirements file using uv export (preferred method), otherwise fall back to uv pip freeze
+	# Export dependencies to requirements file using uv export.
 	uv export --no-hashes --no-sources --no-header --no-dev --no-emit-project --no-annotate --frozen > .requirements.txt 2>/dev/null || \
-	uv pip freeze --exclude-editable > .requirements.txt && uv run app/agent_engine_app.py
+	uv export --no-hashes --no-sources --no-header --no-dev --no-emit-project --frozen > .requirements.txt && uv run app/agent_engine_app.py
 {%- endif %}
+{%- if cookiecutter.deployment_target == 'cloud_run' %}
 
-{% if cookiecutter.deployment_target == 'cloud_run' -%}
-ui:
+local-backend:
+	uv run uvicorn app.server:app --host 0.0.0.0 --port 8000 --reload
+{%- endif %}
+{%- if cookiecutter.deployment_target == 'cloud_run' %}
 {%- if cookiecutter.agent_name == 'live_api' %}
+
+ui:
 	npm --prefix frontend start
-{%- else %}
-	uv run streamlit run streamlit/streamlit_app.py --browser.serverAddress=localhost --server.enableCORS=false --server.enableXsrfProtection=false
 {%- endif %}
 {%- endif %}
 
 setup-dev-env:
-	@if [ -z "$$PROJECT_ID" ]; then echo "Error: PROJECT_ID environment variable is not set"; exit 1; fi
+	PROJECT_ID=$$(gcloud config get-value project) && \
 	(cd deployment/terraform/dev && terraform init && terraform apply --var-file vars/env.tfvars --var dev_project_id=$$PROJECT_ID --auto-approve)
-{% if cookiecutter.data_ingestion %}
+
+{%- if cookiecutter.data_ingestion %}
+
 data-ingestion:
-	@if [ -z "$$PROJECT_ID" ]; then echo "Error: PROJECT_ID environment variable is not set"; exit 1; fi
-	$(MAKE) install
+	PROJECT_ID=$$(gcloud config get-value project) && \
 	(cd data_ingestion && uv run data_ingestion_pipeline/submit_pipeline.py \
 		--project-id=$$PROJECT_ID \
 		--region="us-central1" \

{agent_starter_pack-0.3.4 → agent_starter_pack-0.3.5}/src/base_template/README.md

@@ -48,11 +48,16 @@ make install && make playground
 | `make install`       | Install all required dependencies using uv                                                  |
 {%- if cookiecutter.deployment_target == 'cloud_run' %}
 | `make playground`    | Launch local development environment with backend and frontend{%- if "adk" in cookiecutter.tags %} - leveraging `adk web` command. {%- endif %}|
-| `make backend`       | Start backend server only |
-| `make ui`            | Launch Streamlit frontend without local backend |
+| `make backend`       | Deploy agent to Cloud Run |
+| `make local-backend`       | Deploy agent to Cloud Run |
+{%- if cookiecutter.deployment_target == 'cloud_run' %}
+{%- if cookiecutter.agent_name == 'live_api' %}
+| `make ui`       | Launch Agent Playground front-end only |
+{%- endif %}
+{%- endif %}
 {%- elif cookiecutter.deployment_target == 'agent_engine' %}
 | `make playground`    | Launch Streamlit interface for testing agent locally and remotely |
-| `make backend`       | Deploy agent to Agent Engine service |
+| `make backend`       | Deploy agent to Agent Engine |
 {%- endif %}
 | `make test`          | Run unit and integration tests                                                              |
 | `make lint`          | Run code quality checks (codespell, ruff, mypy)                                             |
@@ -158,24 +163,12 @@ This template follows a "bring your own agent" approach - you focus on your busi
 
 ### Dev Environment
 
-{%- if cookiecutter.deployment_target == 'agent_engine' %}
 You can test deployment towards a Dev Environment using the following command:
 
 ```bash
 gcloud config set project <your-dev-project-id>
 make backend
 ```
-{%- elif cookiecutter.deployment_target == 'cloud_run' %}
-Deploy the application directly to Cloud Run from your source code using the following `gcloud` command:
-
-```bash
-gcloud run deploy genai-app-sample \
-  --source . \
-  --project YOUR_PROJECT_ID \
-  --region YOUR_GCP_REGION \
-  --memory "4Gi" \
-```
-Replace `YOUR_PROJECT_ID` with your Google Cloud project ID and `YOUR_GCP_REGION` with the desired region (e.g., `us-central1`). Adjust memory and other flags as needed for your environment.
 {% if cookiecutter.agent_name == 'live_api' %}
 **Accessing the Deployed Backend Locally:**
 
@@ -190,7 +183,6 @@ To connect your local frontend (`make ui`) to the backend deployed on Cloud Run,
 
 2.  **Connect Frontend:** Your deployed backend is now accessible locally at `http://localhost:8000`. Point your Streamlit UI to this address.
 {%- endif %}
-{%- endif %}
 
 The repository includes a Terraform configuration for the setup of the Dev Google Cloud project.
 See [deployment/README.md](deployment/README.md) for instructions.
@@ -201,8 +193,8 @@ The repository includes a Terraform configuration for the setup of a production
 
 {% if cookiecutter.agent_name != 'live_api' %}
 ## Monitoring and Observability
-
-> You can use [this Looker Studio dashboard](https://lookerstudio.google.com/c/reporting/fa742264-4b4b-4c56-81e6-a667dd0f853f/page/tEnnC) template for visualizing events being logged in BigQuery. See the "Setup Instructions" tab to getting started.
+> You can use [this Looker Studio dashboard]({%- if "adk" in cookiecutter.tags %}https://lookerstudio.google.com/reporting/46b35167-b38b-4e44-bd37-701ef4307418/page/tEnnC{%- else %}https://lookerstudio.google.com/c/reporting/fa742264-4b4b-4c56-81e6-a667dd0f853f/page/tEnnC{%- endif %}
+) template for visualizing events being logged in BigQuery. See the "Setup Instructions" tab to getting started.
 
 The application uses OpenTelemetry for comprehensive observability with all events being sent to Google Cloud Trace and Logging for monitoring and to BigQuery for long term storage. 
 {%- endif %}

{agent_starter_pack-0.3.4 → agent_starter_pack-0.3.5}/src/base_template/deployment/cd/deploy-to-prod.yaml

@@ -67,6 +67,8 @@ steps:
       - "--service-account"
       - "${_CLOUD_RUN_APP_SA_EMAIL}"
       - "--session-affinity"
+      - "--labels"
+      - "created-by=adk"
       - "--set-env-vars"
       - "COMMIT_SHA=${COMMIT_SHA}{%- if cookiecutter.data_ingestion %}{%- if cookiecutter.datastore_type == "vertex_ai_search" %},DATA_STORE_ID=${_DATA_STORE_ID},DATA_STORE_REGION=${_DATA_STORE_REGION}{%- elif cookiecutter.datastore_type == "vertex_ai_vector_search" %},VECTOR_SEARCH_INDEX=${_VECTOR_SEARCH_INDEX},VECTOR_SEARCH_INDEX_ENDPOINT=${_VECTOR_SEARCH_INDEX_ENDPOINT},VECTOR_SEARCH_BUCKET=${_VECTOR_SEARCH_BUCKET}{%- endif %}{%- endif %}"
 {%- elif cookiecutter.deployment_target == 'agent_engine' %}

{agent_starter_pack-0.3.4 → agent_starter_pack-0.3.5}/src/base_template/deployment/cd/staging.yaml

@@ -81,6 +81,8 @@ steps:
       - "--service-account"
       - "${_CLOUD_RUN_APP_SA_EMAIL}"
       - "--session-affinity"
+      - "--labels"
+      - "created-by=adk"
       - "--set-env-vars"
       - "COMMIT_SHA=${COMMIT_SHA}{%- if cookiecutter.data_ingestion %}{%- if cookiecutter.datastore_type == "vertex_ai_search" %},DATA_STORE_ID=${_DATA_STORE_ID},DATA_STORE_REGION=${_DATA_STORE_REGION}{%- elif cookiecutter.datastore_type == "vertex_ai_vector_search" %},VECTOR_SEARCH_INDEX=${_VECTOR_SEARCH_INDEX},VECTOR_SEARCH_INDEX_ENDPOINT=${_VECTOR_SEARCH_INDEX_ENDPOINT},VECTOR_SEARCH_BUCKET=${_VECTOR_SEARCH_BUCKET}{%- endif %}{%- endif %}"
 

{agent_starter_pack-0.3.4 → agent_starter_pack-0.3.5}/src/frontends/live_api_react/frontend/package-lock.json

@@ -10046,9 +10046,9 @@
       }
     },
     "node_modules/http-proxy-middleware": {
-      "version": "2.0.7",
-      "resolved": "https://registry.npmjs.org/http-proxy-middleware/-/http-proxy-middleware-2.0.7.tgz",
-      "integrity": "sha512-fgVY8AV7qU7z/MmXJ/rxwbrtQH4jBQ9m7kp3llF0liB7glmFeVZFBepQb32T3y8n8k2+AEYuMPCpinYW+/CuRA==",
+      "version": "2.0.9",
+      "resolved": "https://registry.npmjs.org/http-proxy-middleware/-/http-proxy-middleware-2.0.9.tgz",
+      "integrity": "sha512-c1IyJYLYppU574+YI7R4QyX2ystMtVXZwIdzazUIPIJsHuWNd+mho2j+bKoHftndicGj9yh+xjd+l0yj7VeT1Q==",
       "license": "MIT",
       "dependencies": {
         "@types/http-proxy": "^1.17.8",