use cookiecutter for template

Author: yaozheng-fang

pyproject.toml

@@ -43,6 +43,7 @@ cli = [
     "volcengine-python-sdk==4.0.3", # For Volcengine API
     "agent-pilot-sdk>=0.0.9",       # Prompt optimization by Volcengine AgentPilot/PromptPilot toolkits
     "fastmcp>=2.11.3",              # For running MCP
+    "cookiecutter>=2.6.0", # For cloud deploy
 ]
 dev = [
     "pre-commit>=4.2.0",            # Format checking
@@ -69,4 +70,9 @@ exclude = ["assets*", "ide*", "tests*"]
 include-package-data = true
 
 [tool.setuptools.package-data]
-"veadk" = ["**/*"]
+"veadk" = ["**/*"]
+
+[tool.ruff]
+exclude = [
+    "veadk/integrations/ve_faas/template/*"
+]

veadk/cli/cli.py

@@ -18,8 +18,11 @@
 from veadk.cli.cli_init import init
 from veadk.cli.cli_prompt import prompt
 from veadk.cli.cli_web import web
+from veadk.utils.logger import get_logger
 from veadk.version import VERSION
 
+logger = get_logger(__name__)
+
 
 @click.group()
 @click.version_option(

veadk/cli/cli_deploy.py

@@ -14,6 +14,8 @@
 
 import click
 
+TEMP_PATH = "/tmp"
+
 
 @click.command()
 @click.option(
@@ -26,21 +28,96 @@
     default=None,
     help="Volcengine secret key",
 )
-@click.option("--name", help="Expected Volcengine FaaS application name")
+@click.option("--vefaas-app-name", help="Expected Volcengine FaaS application name")
+@click.option("--veapig-instance-name", help="Expected Volcengine APIG instance name")
+@click.option("--veapig-service-name", help="Expected Volcengine APIG service name")
+@click.option("--veapig-upstream-name", help="Expected Volcengine APIG upstream name")
+@click.option(
+    "--short-term-memory-backend",
+    default="local",
+    type=click.Choice(["local", "mysql"]),
+    help="Backend for short-term memory",
+)
+@click.option("--use-adk-web", is_flag=True, help="Whether to use ADK Web")
 @click.option("--path", default=".", help="Local project path")
-def deploy(access_key: str, secret_key: str, name: str, path: str) -> None:
+def deploy(
+    access_key: str,
+    secret_key: str,
+    vefaas_app_name: str,
+    veapig_instance_name: str,
+    veapig_service_name: str,
+    veapig_upstream_name: str,
+    short_term_memory_backend: str,
+    use_adk_web: bool,
+    path: str,
+) -> None:
     """Deploy a user project to Volcengine FaaS application."""
+    import shutil
     from pathlib import Path
 
+    from cookiecutter.main import cookiecutter
+
+    import veadk.integrations.ve_faas as vefaas
     from veadk.config import getenv
-    from veadk.integrations.ve_faas.ve_faas import VeFaaS
+    from veadk.utils.misc import formatted_timestamp
 
     if not access_key:
         access_key = getenv("VOLCENGINE_ACCESS_KEY")
     if not secret_key:
         secret_key = getenv("VOLCENGINE_SECRET_KEY")
 
     user_proj_abs_path = Path(path).resolve()
+    template_dir_path = Path(vefaas.__file__).parent / "template"
+
+    tmp_dir_name = f"{user_proj_abs_path.name}_{formatted_timestamp()}"
+
+    settings = {
+        "local_dir_name": tmp_dir_name,
+        "app_name": user_proj_abs_path.name,
+        "agent_module_name": user_proj_abs_path.name,
+        "requirement_file_path": str(user_proj_abs_path / "requirements.txt"),
+        "short_term_memory_backend": short_term_memory_backend,
+        "vefaas_application_name": vefaas_app_name,
+        "veapig_instance_name": veapig_instance_name,
+        "veapig_service_name": veapig_service_name,
+        "veapig_upstream_name": veapig_upstream_name,
+        "use_adk_web": use_adk_web,
+    }
+
+    print(settings)
+
+    cookiecutter(
+        template=str(template_dir_path),
+        output_dir=TEMP_PATH,
+        no_input=True,
+        extra_context=settings,
+    )
+
+    agent_dir = (
+        Path(TEMP_PATH)
+        / tmp_dir_name
+        / "src"
+        / user_proj_abs_path.name.replace("-", "_")
+    )
+
+    # remove /tmp/tmp_dir_name/src/user_proj_abs_path.name
+    shutil.rmtree(agent_dir)
+    agent_dir.mkdir(parents=True, exist_ok=True)
+
+    # mv
+    shutil.copytree(user_proj_abs_path, agent_dir, dirs_exist_ok=True)
+
+    # mv requirements.txt and config.yaml if have
+    if (user_proj_abs_path / "requirements.txt").exists():
+        shutil.copy(
+            user_proj_abs_path / "requirements.txt",
+            f"{TEMP_PATH}/{tmp_dir_name}/requirements.txt",
+        )
+        # remove file
 
-    ve_faas = VeFaaS(access_key=access_key, secret_key=secret_key)
-    ve_faas.deploy(name=name, path=str(user_proj_abs_path))
+    if (user_proj_abs_path / "config.yaml").exists():
+        shutil.copy(
+            user_proj_abs_path / "config.yaml",
+            f"{TEMP_PATH}/{tmp_dir_name}/config.yaml",
+        )
+        # remove file

veadk/cli/cli_init.py

@@ -12,97 +12,20 @@
 # See the License for the specific language governing permissions and
 # limitations under the License.
 
-from typing import Any
-
 import click
 
 
-def _set_variable_in_file(file_path: str, setting_values: dict):
-    import ast
-
-    with open(file_path, "r", encoding="utf-8") as f:
-        source_code = f.read()
-
-    tree = ast.parse(source_code)
-
-    class VariableTransformer(ast.NodeTransformer):
-        def visit_Assign(self, node: ast.Assign):
-            for target in node.targets:
-                if isinstance(target, ast.Name) and target.id in setting_values:
-                    node.value = ast.Constant(value=setting_values[target.id])
-            return node
-
-    transformer = VariableTransformer()
-    new_tree = transformer.visit(tree)
-    ast.fix_missing_locations(new_tree)
-    new_source_code = ast.unparse(new_tree)
-
-    with open(file_path, "w", encoding="utf-8") as f:
-        f.write(new_source_code)
-
-    click.echo("Your project has beed created.")
-
-
-def _render_prompts() -> dict[str, Any]:
-    vefaas_application_name = click.prompt(
-        "Volcengine FaaS application name", default="veadk-cloud-agent"
-    )
-
-    gateway_name = click.prompt(
-        "Volcengine gateway instance name", default="", show_default=True
-    )
-
-    gateway_service_name = click.prompt(
-        "Volcengine gateway service name", default="", show_default=True
-    )
-
-    gateway_upstream_name = click.prompt(
-        "Volcengine gateway upstream name", default="", show_default=True
-    )
-
-    deploy_mode_options = {
-        "1": "A2A/MCP Server",
-        "2": "VeADK Web / Google ADK Web",
-    }
-
-    click.echo("Choose a deploy mode:")
-    for key, value in deploy_mode_options.items():
-        click.echo(f"  {key}. {value}")
-
-    deploy_mode = click.prompt(
-        "Enter your choice", type=click.Choice(deploy_mode_options.keys())
-    )
-
-    return {
-        "VEFAAS_APPLICATION_NAME": vefaas_application_name,
-        "GATEWAY_NAME": gateway_name,
-        "GATEWAY_SERVICE_NAME": gateway_service_name,
-        "GATEWAY_UPSTREAM_NAME": gateway_upstream_name,
-        "USE_ADK_WEB": deploy_mode == deploy_mode_options["2"],
-    }
-
-
 @click.command()
 def init() -> None:
     """Init a veadk project that can be deployed to Volcengine VeFaaS."""
-    import shutil
     from pathlib import Path
 
+    from cookiecutter.main import cookiecutter
+
     import veadk.integrations.ve_faas as vefaas
 
     cwd = Path.cwd()
-    local_dir_name = click.prompt("Directory name", default="veadk-cloud-proj")
-    target_dir_path = cwd / local_dir_name
-
-    if target_dir_path.exists():
-        click.confirm(
-            f"Directory '{target_dir_path}' already exists, do you want to overwrite it",
-            abort=True,
-        )
-        shutil.rmtree(target_dir_path)
-
-    setting_values = _render_prompts()
 
     template_dir_path = Path(vefaas.__file__).parent / "template"
-    shutil.copytree(template_dir_path, target_dir_path)
-    _set_variable_in_file(target_dir_path / "deploy.py", setting_values)
+
+    cookiecutter(template=str(template_dir_path), output_dir=str(cwd))

veadk/cloud/cloud_agent_engine.py

@@ -13,6 +13,7 @@
 # limitations under the License.
 
 import os
+import shutil
 import socket
 import subprocess
 import time
@@ -66,29 +67,29 @@ def _prepare(self, path: str, name: str):
             )
 
         # prepare template files if not have
-        template_files = [
-            "app.py",
-            "run.sh",
-            # "requirements.txt",
-            "__init__.py",
-        ]
-        for template_file in template_files:
-            if os.path.exists(os.path.join(path, template_file)):
-                logger.warning(
-                    f"Local agent project path `{path}` contains a `{template_file}` file. Use your own `{template_file}` file may cause unexpected behavior."
-                )
-            else:
-                logger.info(
-                    f"No `{template_file}` detected in local agent project path `{path}`. Prepare it."
-                )
-                import veadk.integrations.ve_faas as vefaas
-
-                template_file_path = (
-                    Path(vefaas.__file__).parent / "template" / "src" / template_file
-                )
-                import shutil
-
-                shutil.copy(template_file_path, os.path.join(path, template_file))
+        # template_files = [
+        #     "app.py",
+        #     "run.sh",
+        #     # "requirements.txt",
+        #     "__init__.py",
+        # ]
+        # for template_file in template_files:
+        #     if os.path.exists(os.path.join(path, template_file)):
+        #         logger.warning(
+        #             f"Local agent project path `{path}` contains a `{template_file}` file. Use your own `{template_file}` file may cause unexpected behavior."
+        #         )
+        #     else:
+        #         logger.info(
+        #             f"No `{template_file}` detected in local agent project path `{path}`. Prepare it."
+        #         )
+        #         import veadk.integrations.ve_faas as vefaas
+
+        #         template_file_path = (
+        #             Path(vefaas.__file__).parent / "template" / "src" / template_file
+        #         )
+        #         import shutil
+
+        #         shutil.copy(template_file_path, os.path.join(path, template_file))
 
         # copy user's requirements.txt
         if os.path.exists(os.path.join(path, "requirements.txt")):

veadk/integrations/ve_faas/template/README.md

@@ -0,0 +1,12 @@
+{
+  "local_dir_name": "veadk_vefaas_proj",
+  "app_name": "weather-report",
+  "agent_module_name": "weather_agent",
+  "requirement_file_path": "./weather_agent/requirements.txt",
+  "short_term_memory_backend": "local",
+  "vefaas_application_name": "weather-reporter",
+  "veapig_instance_name": "",
+  "veapig_service_name": "",
+  "veapig_upstream_name": "",
+  "use_adk_web": false
+}

veadk/integrations/ve_faas/template/cookiecutter.json

@@ -24,12 +24,6 @@
 SESSION_ID = "cloud_app_test_session"
 USER_ID = "cloud_app_test_user"
 
-VEFAAS_APPLICATION_NAME = "weather-reporter"
-GATEWAY_NAME = ""
-GATEWAY_SERVICE_NAME = ""
-GATEWAY_UPSTREAMNAME = ""
-USE_ADK_WEB = False
-
 
 async def _send_msg_with_a2a(cloud_app: CloudApp, message: str) -> None:
     print("===== A2A example =====")
@@ -85,16 +79,16 @@ async def main():
 
     cloud_app = engine.deploy(
         path=str(Path(__file__).parent / "src"),
-        application_name=VEFAAS_APPLICATION_NAME,
-        gateway_name=GATEWAY_NAME,
-        gateway_service_name=GATEWAY_SERVICE_NAME,
-        gateway_upstream_name=GATEWAY_UPSTREAMNAME,
-        use_adk_web=USE_ADK_WEB,
+        application_name="{{cookiecutter.vefaas_application_name}}",
+        gateway_name="{{cookiecutter.veapig_instance_name}}",
+        gateway_service_name="{{cookiecutter.veapig_service_name}}",
+        gateway_upstream_name="{{cookiecutter.veapig_upstream_name}}",
+        use_adk_web={{cookiecutter.use_adk_web}},
         local_test=False,  # Set to True for local testing before deploy to VeFaaS
     )
     print(f"VeFaaS application ID: {cloud_app.vefaas_application_id}")
 
-    if USE_ADK_WEB:
+    if {{cookiecutter.use_adk_web}}:
         print(f"Web is running at: {cloud_app.vefaas_endpoint}")
     else:
         # Test with deployed cloud application