agent-starter-pack 0.0.10b0__py3-none-any.whl → 0.0.12b0__py3-none-any.whl

{agent_starter_pack-0.0.10b0.dist-info → agent_starter_pack-0.0.12b0.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: agent-starter-pack
-Version: 0.0.10b0
+Version: 0.0.12b0
 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
@@ -9,7 +9,6 @@ Requires-Python: >=3.10
 Requires-Dist: click~=8.1.7
 Requires-Dist: cookiecutter~=2.5.0
 Requires-Dist: google-cloud-aiplatform~=1.81.0
-Requires-Dist: inquirer~=3.1.3
 Requires-Dist: pyyaml~=6.0.1
 Requires-Dist: rich~=13.7.0
 Provides-Extra: jupyter
@@ -53,6 +52,7 @@ agent-starter-pack create my-awesome-agent
 ```
 
 **That's it!** You now have a fully functional agent project, complete with a backend, frontend, and deployment infrastructure, ready to explore and customize.
+For more installation options, see the [Installation Guide](docs/installation.md).
 
 ---
 
@@ -114,10 +114,13 @@ This project represents the next evolution of the [e2e-gen-ai-app-starter-pack](
 See the [documentation](docs/) for more details:
 
 - [Why Use the Starter Pack?](docs/why_starter_pack.md)
+- [Installation](docs/installation.md)
 - [Deployment](docs/deployment.md)
 - [Data Ingestion](docs/data-ingestion.md)
 - [Observability](docs/observability.md)
 - [CLI Reference](docs/cli/README.md)
+- [CLI Reference](docs/cli/README.md)
+- [Troubleshooting](docs/troubleshooting.md)
 
 **Video Walkthrough:** A [20-Minute Video Walkthrough](https://youtu.be/kwRG7cnqSu0) is available, showcasing the previous `e2e-gen-ai-app-starter-pack`. A new walkthrough for the `agent-starter-pack` will be released soon!
 

{agent_starter_pack-0.0.10b0.dist-info → agent_starter_pack-0.0.12b0.dist-info}/RECORD

@@ -29,8 +29,8 @@ agents/multimodal_live_api/tests/integration/test_server_e2e.py,sha256=D2VETDIyT
 agents/multimodal_live_api/tests/load_test/load_test.py,sha256=HHZyfC4gqiQtZVF_CbbxENGgWQccMLpwMv0IdoQ6cbQ,1275
 agents/multimodal_live_api/tests/unit/test_server.py,sha256=_TjlgQgNkjerIaBGnu8P8_KB8ZlSolDcivALpUOn_Rw,4786
 src/base_template/.gitignore,sha256=mJKTZIcVdAFiIUQicRfPNGUg6WvwcfTEC2xbmAaU34g,2579
-src/base_template/Makefile,sha256=YQXymaikoFP3r7MN1EiNbQv8VZKjrVzeRoksIPHNX0E,1568
-src/base_template/README.md,sha256=LS07ZhCLj2SXew3j3xEWaaXwsf3aIjyvQpkp0S0l8nA,4194
+src/base_template/Makefile,sha256=PNmyhdIRf0p6eRLYqWHfCskLmuDMG673YPEeu51XLVQ,1720
+src/base_template/README.md,sha256=PS5cKkBPgoAHPcRYMxgynx82PBcMK21xZ_eQehrI-b8,4922
 src/base_template/pyproject.toml,sha256=Pv4nC4uh_9_sGA90Tom0ITJUAbGolhseCA9-AOaEIpY,2799
 src/base_template/app/utils/tracing.py,sha256=ovp6tgwgo_tqibpbhhHl8cWIqqUWVYfV0AL7XPDEPpM,5661
 src/base_template/app/utils/typing.py,sha256=UUFm74qiKGtT8pLuE_3yRpcmntRCt91wH_Q-LKdjQuQ,3194
@@ -56,11 +56,11 @@ src/base_template/deployment/terraform/dev/variables.tf,sha256=wMgDgp1E-piGhcF1W
 src/base_template/deployment/terraform/dev/vars/env.tfvars,sha256=xz5cYG29ZIgqM1K-0o-RB10oBTDKNIhHMY7qrmjHk8I,922
 src/base_template/deployment/terraform/vars/env.tfvars,sha256=2dxWRDzeolN2f7eKSHXcBiBt9fRcIMO6VH-2MAZevLQ,1633
 src/base_template/tests/unit/test_utils/test_tracing_exporter.py,sha256=JAb0vIB7wNFPm_kaDaHcxtPKNReypDHjdsMQyzpuePQ,4687
-src/cli/main.py,sha256=134KpcOQlexr_vR-KT3D3B1jKh1Y6S3qHGJ-9uD9Kkg,950
-src/cli/commands/create.py,sha256=9WqSRt7t6RYF6SbXsF_igOXevw6C8PIR6d4yMwbpZuM,20953
+src/cli/main.py,sha256=vNEV1Fdl1BhJAFbKHcN3MN1v7dPRUcAgXMnB3uCnlI0,1591
+src/cli/commands/create.py,sha256=38wc5DjUOelLtmCnkVLIq9aVc6c1EK10O0fd-refh6I,18963
 src/cli/commands/setup_cicd.py,sha256=EgVkDdA94npDHHPTuYDmWNIiRscnsXtN7CbTuelrTVU,28347
 src/cli/utils/__init__.py,sha256=x-k6jfcv68_zYS88LrA1mr0yB5y5SekJ0nc5Tvt6iDA,1064
-src/cli/utils/cicd.py,sha256=x-8PKp4aevkUwAmtbEZVwu0UlrA6ifXGbouxICu1D0o,25664
+src/cli/utils/cicd.py,sha256=W44Dt39mZMzfDqA16gG69C8vc6VvBy99QVBJxEIjMI4,26631
 src/cli/utils/gcp.py,sha256=f-XTq9AN2_KrCR8pf_gSPOng8KrvtFlNP2Ok9VtTk_Q,4118
 src/cli/utils/logging.py,sha256=0lHe4EPi1A8sOx9xkA7gS4UNl0GsIyp2ahydkkuCzLY,1570
 src/cli/utils/template.py,sha256=p7uKv5yHkXIOWo8EJJ0IjUh57lOSDL7kYHA9OZ7j-z4,25447
@@ -150,8 +150,8 @@ src/resources/setup_cicd/providers.tf,sha256=Km4z6IJt7x7PLaa0kyZbBrO2m3lpuIJZFD5
 src/utils/generate_locks.py,sha256=xu5IAhGGBPkVQGSJX4kk7_JNDwWJUEaXAHbmaQIohbg,4386
 src/utils/lock_utils.py,sha256=plw3vWkRViCMxBK3IrLRHtF_I0kbbP043T9KIYxcb20,2423
 src/utils/watch_and_rebuild.py,sha256=IdbTLReYknTXXu5KWPz3sc7Zg5HTEMS5UVlMSnuhs5E,6067
-agent_starter_pack-0.0.10b0.dist-info/METADATA,sha256=tWZHbeB2mwGNTnfNqhyhT1VqWd45hfpEwHhWg-KErtk,7205
-agent_starter_pack-0.0.10b0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
-agent_starter_pack-0.0.10b0.dist-info/entry_points.txt,sha256=U7uCxR7YulIhZ0L8R8Hui0Bsy6J7oyESBeDYJYMrQjA,56
-agent_starter_pack-0.0.10b0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
-agent_starter_pack-0.0.10b0.dist-info/RECORD,,
+agent_starter_pack-0.0.12b0.dist-info/METADATA,sha256=M9PRQDNxktA7du5saw1i_35SOfFvF6G2ZToucjz_fko,7379
+agent_starter_pack-0.0.12b0.dist-info/WHEEL,sha256=qtCwoSJWgHk21S1Kb4ihdzI2rlJ1ZKaIurTj_ngOhyQ,87
+agent_starter_pack-0.0.12b0.dist-info/entry_points.txt,sha256=U7uCxR7YulIhZ0L8R8Hui0Bsy6J7oyESBeDYJYMrQjA,56
+agent_starter_pack-0.0.12b0.dist-info/licenses/LICENSE,sha256=xx0jnfkXJvxRnG63LTGOxlggYnIysveWIZ6H3PNdCrQ,11357
+agent_starter_pack-0.0.12b0.dist-info/RECORD,,

src/base_template/Makefile

@@ -1,9 +1,10 @@
-test:
-	uv run pytest tests/unit && uv run pytest tests/integration
-
 install:
+	@command -v uv >/dev/null 2>&1 || { echo "uv is not installed. Installing uv..."; curl -LsSf https://astral.sh/uv/install.sh | sh; source ~/.bashrc; }
 	uv sync --dev {% if cookiecutter.agent_name != 'multimodal_live_api' %}--extra streamlit{%- endif %} --extra jupyter --frozen{% if cookiecutter.agent_name == 'multimodal_live_api' %} && npm --prefix frontend install{%- endif %}
 
+test:
+	uv run pytest tests/unit && uv run pytest tests/integration
+
 playground:
 {%- if cookiecutter.deployment_target == 'cloud_run' %}
 	uv run uvicorn app.server:app --host 0.0.0.0 --port 8000 --reload &

src/base_template/README.md

@@ -21,6 +21,14 @@ This project is organized as follows:
 └── pyproject.toml       # Project dependencies and configuration
 ```
 
+## Requirements
+
+Before you begin, ensure you have:
+- **uv**: Python package manager - [Install](https://docs.astral.sh/uv/getting-started/installation/)
+- **Google Cloud SDK**: For GCP services - [Install](https://cloud.google.com/sdk/docs/install)
+- **Terraform**: For infrastructure deployment - [Install](https://developer.hashicorp.com/terraform/downloads)
+- **make**: Build automation tool - [Install](https://www.gnu.org/software/make/) (pre-installed on most Unix-based systems)
+
 
 ### Installation
 
@@ -30,7 +38,7 @@ Install required packages using uv:
 uv sync --extra jupyter --extra streamlit --frozen
 ```
 
-### Setup
+### Setupx
 
 If not done during the initialization, set your default Google Cloud project and Location:
 
@@ -46,15 +54,17 @@ gcloud auth application-default set-quota-project $PROJECT_ID
 
 | Command              | Description                                                                                 |
 | -------------------- | ------------------------------------------------------------------------------------------- |
+| `make install`       | Install all required dependencies using uv                                                  |
 {%- if cookiecutter.deployment_target == 'cloud_run' %}
 | `make playground`    | Launch local development environment with backend and frontend |
 | `make backend`       | Start backend server only |
-| `make ui`           | Launch Streamlit frontend without local backend |
+| `make ui`            | Launch Streamlit frontend without local backend |
 {%- 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 |
 {%- endif %}
 | `make test`          | Run unit and integration tests                                                              |
+| `make lint`          | Run code quality checks (codespell, ruff, mypy)                                             |
 | `uv run jupyter lab` | Launch Jupyter notebook                                                                     |
 
 For full command options and usage, refer to the [Makefile](Makefile).

src/cli/commands/create.py

@@ -165,8 +165,6 @@ def create(
 
         # Check for uv installation if not skipping checks
         if not skip_checks:
-            check_and_install_uv()
-
             # Set up GCP environment
             try:
                 setup_gcp_environment(
@@ -178,6 +176,17 @@ def create(
             except Exception as e:
                 if debug:
                     logging.warning(f"GCP environment setup failed: {e}")
+                console.print(
+                    f"> Warning: GCP environment setup failed: {e}", style="yellow"
+                )
+                console.print(
+                    "> Please check your authentication settings and permissions. "
+                    "Visit https://cloud.google.com/vertex-ai/docs/authentication for help.",
+                    style="yellow",
+                )
+                console.print(
+                    "> Continuing with template processing...", style="yellow"
+                )
 
         # Process template
         template_path = get_template_path(final_agent, debug=debug)
@@ -527,67 +536,3 @@ def replace_region_in_files(
         except UnicodeDecodeError:
             # Skip files that can't be read as text
             continue
-
-
-def check_and_install_uv() -> None:
-    """Check if uv is installed and install it if not present."""
-    try:
-        # Use shell=True for Windows compatibility and add timeout
-        process = subprocess.run(
-            "uv --version",
-            shell=True,
-            capture_output=True,
-            text=True,
-            timeout=10
-        )
-        if process.returncode == 0:
-            logging.debug("uv is already installed")
-            return
-        else:
-            console.print("> uv command failed", style="yellow")
-    except subprocess.TimeoutExpired:
-        console.print("> uv version check timed out", style="yellow")
-    except (subprocess.CalledProcessError, FileNotFoundError):
-        console.print("> uv is not installed", style="yellow")
-
-    console.print(
-        "\n> uv is required for the template to work. You can install it in several ways:"
-        "\n 1. Automatically install uv now"
-        "\n 2. Manual installation from: https://docs.astral.sh/uv/getting-started/installation"
-        "\n    This includes other options e.g PyPI (pip/pipx), Homebrew, Docker.."
-    )
-
-    install_choice = Prompt.ask(
-        "\n> Would you like to install uv automatically now?",
-        choices=["y", "n"],
-        default="y",
-    )
-    if install_choice.lower() == "y":
-        console.print("> Installing uv...", style="yellow")
-        try:
-            install_command = "curl -LsSf https://astral.sh/uv/install.sh | sh"
-            # Add timeout to installation process as well
-            subprocess.run(
-                install_command,
-                shell=True,
-                check=True,
-                timeout=60  # Give installation more time
-            )
-            console.print("> uv installed successfully!", style="green")
-        except subprocess.TimeoutExpired:
-            console.print("> uv installation timed out", style="bold red")
-            raise
-        except subprocess.CalledProcessError as e:
-            console.print("> Failed to install uv", style="bold red")
-            logging.debug(f"uv installation error: {e!s}")
-            console.print(
-                "> Please install uv manually using one of the methods listed above",
-                style="yellow",
-            )
-            raise
-    else:
-        console.print(
-            "> Please install uv manually using one of the methods listed above and try again",
-            style="yellow",
-        )
-        raise click.Abort() from None

src/cli/main.py

@@ -12,24 +12,46 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
+import importlib.metadata
+
 import click
 from rich.console import Console
 
-from src.cli.commands.create import create
-from src.cli.commands.setup_cicd import setup_cicd
+from .commands.create import create
+from .commands.setup_cicd import setup_cicd
 
 console = Console()
 
 
-@click.group()
+def print_version(ctx: click.Context, param: click.Parameter, value: bool) -> None:
+    if not value or ctx.resilient_parsing:
+        return
+    try:
+        version_str = importlib.metadata.version("agent-starter-pack")
+        console.print(f"GCP Agent Starter Pack CLI version: {version_str}")
+    except importlib.metadata.PackageNotFoundError:
+        console.print("GCP Agent Starter Pack CLI (development version)")
+    ctx.exit()
+
+
+@click.group(help="Production-ready Generative AI Agent templates for Google Cloud")
+@click.option(
+    "--version",
+    "-v",
+    is_flag=True,
+    callback=print_version,
+    expose_value=False,
+    is_eager=True,
+    help="Show the version and exit.",
+)
 def cli() -> None:
-    """GCP Agent Starter CLI tool"""
     pass
 
 
-# Register commands with the CLI group
+# Register commands
 cli.add_command(create)
 cli.add_command(setup_cicd)
 
+
 if __name__ == "__main__":
     cli()

src/cli/utils/cicd.py

@@ -257,6 +257,17 @@ def create_github_connection(
             elif status == "PENDING_USER_OAUTH" or status == "PENDING_INSTALL_APP":
                 if attempt < max_retries - 1:  # Don't print waiting on last attempt
                     console.print("⏳ Waiting for GitHub authorization...")
+                    # Extract and print the action URI for user authentication
+                    try:
+                        action_uri = json.loads(result.stdout).get("installationState", {}).get("actionUri")
+                        if action_uri:
+                            console.print("\n🔑 Authentication Required:", style="bold yellow")
+                            console.print(f"Please visit [link={action_uri}]this page[/link] to authenticate Cloud Build with GitHub:")
+                            console.print(f"{action_uri}", style="bold blue")
+                            console.print("(Copy and paste the link into your browser if clicking doesn't work)")
+                            console.print("After completing authentication, return here to continue the setup.\n")
+                    except (json.JSONDecodeError, KeyError) as e:
+                        console.print(f"⚠️ Could not extract authentication link: {e}", style="yellow")
                     time.sleep(10)
                 continue
             else: