veadk-python 0.2.4__py3-none-any.whl → 0.2.6__py3-none-any.whl

veadk/integrations/ve_cr/__init__.py

@@ -0,0 +1,13 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# 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.

veadk/integrations/ve_cr/ve_cr.py

@@ -0,0 +1,205 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# 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.
+
+from veadk.utils.volcengine_sign import ve_request
+from veadk.utils.logger import get_logger
+from veadk.consts import (
+    DEFAULT_CR_INSTANCE_NAME,
+    DEFAULT_CR_NAMESPACE_NAME,
+    DEFAULT_CR_REPO_NAME,
+)
+import time
+
+logger = get_logger(__name__)
+
+
+class VeCR:
+    def __init__(self, access_key: str, secret_key: str, region: str = "cn-beijing"):
+        self.ak = access_key
+        self.sk = secret_key
+        self.region = region
+        assert region in ["cn-beijing", "cn-guangzhou", "cn-shanghai"]
+        self.version = "2022-05-12"
+
+    def _create_instance(self, instance_name: str = DEFAULT_CR_INSTANCE_NAME) -> str:
+        """
+        create cr instance
+
+        Args:
+            instance_name: cr instance name
+
+        Returns:
+            cr instance name
+        """
+        status = self._check_instance(instance_name)
+        if status != "NONEXIST":
+            logger.debug(f"cr instance {instance_name} already running")
+            return instance_name
+        response = ve_request(
+            request_body={
+                "Name": instance_name,
+                "ResourceTags": [
+                    {"Key": "provider", "Value": "veadk"},
+                ],
+            },
+            action="CreateRegistry",
+            ak=self.ak,
+            sk=self.sk,
+            service="cr",
+            version=self.version,
+            region=self.region,
+            host=f"cr.{self.region}.volcengineapi.com",
+        )
+        logger.debug(f"create cr instance {instance_name}: {response}")
+
+        while True:
+            status = self._check_instance(instance_name)
+            if status == "Running":
+                break
+            elif status == "Failed":
+                raise ValueError(f"cr instance {instance_name} create failed")
+            else:
+                logger.debug(f"cr instance status: {status}")
+                time.sleep(5)
+
+        return instance_name
+
+    def _check_instance(self, instance_name: str) -> str:
+        """
+        check cr instance status
+
+        Args:
+            instance_name: cr instance name
+
+        Returns:
+            cr instance status
+        """
+        response = ve_request(
+            request_body={
+                "Filter": {
+                    "Names": [instance_name],
+                }
+            },
+            action="ListRegistries",
+            ak=self.ak,
+            sk=self.sk,
+            service="cr",
+            version=self.version,
+            region=self.region,
+            host=f"cr.{self.region}.volcengineapi.com",
+        )
+        logger.debug(f"check cr instance {instance_name}: {response}")
+
+        try:
+            if response["Result"]["TotalCount"] == 0:
+                return "NONEXIST"
+            return response["Result"]["Items"][0]["Status"]["Phase"]
+        except Exception as _:
+            raise ValueError(f"Error check cr instance {instance_name}: {response}")
+
+    def _create_namespace(
+        self,
+        instance_name: str = DEFAULT_CR_INSTANCE_NAME,
+        namespace_name: str = DEFAULT_CR_NAMESPACE_NAME,
+    ) -> str:
+        """
+        create cr namespace
+
+        Args:
+            instance_name: cr instance name
+            namespace_name: cr namespace name
+
+        Returns:
+            cr namespace name
+        """
+        response = ve_request(
+            request_body={
+                "Name": namespace_name,
+                "Registry": instance_name,
+            },
+            action="CreateNamespace",
+            ak=self.ak,
+            sk=self.sk,
+            service="cr",
+            version=self.version,
+            region=self.region,
+            host=f"cr.{self.region}.volcengineapi.com",
+        )
+        logger.debug(f"create cr namespace {namespace_name}: {response}")
+
+        if "Error" in response["ResponseMetadata"]:
+            error_code = response["ResponseMetadata"]["Error"]["Code"]
+            error_message = response["ResponseMetadata"]["Error"]["Message"]
+            if error_code == "AlreadyExists.Namespace":
+                logger.debug(f"cr namespace {namespace_name} already exists")
+                return namespace_name
+            else:
+                logger.error(
+                    f"Error create cr namespace {namespace_name}: {error_code} {error_message}"
+                )
+                raise ValueError(
+                    f"Error create cr namespace {namespace_name}: {error_code} {error_message}"
+                )
+
+        return namespace_name
+
+    def _create_repo(
+        self,
+        instance_name: str = DEFAULT_CR_INSTANCE_NAME,
+        namespace_name: str = DEFAULT_CR_NAMESPACE_NAME,
+        repo_name: str = DEFAULT_CR_REPO_NAME,
+    ) -> str:
+        """
+        create cr repo
+
+        Args:
+            instance_name: cr instance name
+            namespace_name: cr namespace name
+            repo_name: cr repo name
+
+        Returns:
+            cr repo name
+        """
+        response = ve_request(
+            request_body={
+                "Name": repo_name,
+                "Registry": instance_name,
+                "Namespace": namespace_name,
+                "Description": "veadk cr repo",
+            },
+            action="CreateRepository",
+            ak=self.ak,
+            sk=self.sk,
+            service="cr",
+            version=self.version,
+            region=self.region,
+            host=f"cr.{self.region}.volcengineapi.com",
+        )
+        logger.debug(f"create cr repo {repo_name}: {response}")
+
+        if "Error" in response["ResponseMetadata"]:
+            error_code = response["ResponseMetadata"]["Error"]["Code"]
+            error_message = response["ResponseMetadata"]["Error"]["Message"]
+            if error_code == "AlreadyExists.Repository":
+                logger.debug(f"cr repo {repo_name} already exists")
+                return repo_name
+            else:
+                logger.error(
+                    f"Error create cr repo {repo_name}: {error_code} {error_message}"
+                )
+                raise ValueError(
+                    f"Error create cr repo {repo_name}: {error_code} {error_message}"
+                )
+
+        return repo_name

veadk/integrations/ve_faas/template/cookiecutter.json

@@ -7,5 +7,6 @@
   "veapig_instance_name": "",
   "veapig_service_name": "",
   "veapig_upstream_name": "",
-  "use_adk_web": false
+  "use_adk_web": false,
+  "veadk_version": ""
 }

veadk/integrations/ve_faas/template/{{cookiecutter.local_dir_name}}/clean.py

@@ -0,0 +1,23 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# 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.
+
+from veadk.cloud.cloud_app import CloudApp
+
+def main() -> None:
+    cloud_app = CloudApp(vefaas_application_name="{{cookiecutter.vefaas_application_name}}")
+    cloud_app.delete_self()
+
+
+if __name__ == "__main__":
+    main()

veadk/integrations/ve_faas/template/{{cookiecutter.local_dir_name}}/src/app.py

@@ -26,6 +26,7 @@ from fastmcp import FastMCP
 from starlette.routing import Route
 
 from google.adk.a2a.utils.agent_card_builder import AgentCardBuilder
+from a2a.types import AgentProvider
 
 from veadk.a2a.ve_a2a_server import init_app
 from veadk.runner import Runner
@@ -35,6 +36,8 @@ from veadk.tracing.telemetry.exporters.tls_exporter import TLSExporter
 from veadk.tracing.telemetry.opentelemetry_tracer import OpentelemetryTracer
 from veadk.types import AgentRunConfig
 from veadk.utils.logger import get_logger
+from opentelemetry.trace.propagation.tracecontext import TraceContextTextMapPropagator
+from opentelemetry import context
 
 logger = get_logger(__name__)
 
@@ -46,7 +49,9 @@ app_name = agent_run_config.app_name
 agent = agent_run_config.agent
 short_term_memory = agent_run_config.short_term_memory
 
-agent_card_builder = AgentCardBuilder(agent=agent)
+VEFAAS_REGION = os.getenv("APP_REGION", "cn-beijing")
+VEFAAS_FUNC_ID = os.getenv("_FAAS_FUNC_ID", "")
+agent_card_builder = AgentCardBuilder(agent=agent, provider=AgentProvider(organization="Volcengine Agent Development Kit (VeADK)", url=f"https://console.volcengine.com/vefaas/region:vefaas+{VEFAAS_REGION}/function/detail/{VEFAAS_FUNC_ID}"))
 
 
 def load_tracer() -> None:
@@ -114,6 +119,8 @@ async def agent_card() -> dict:
     agent_card = await agent_card_builder.build()
     return agent_card.model_dump()
 
+async def get_cozeloop_space_id() -> dict:
+    return {"space_id": os.getenv("OBSERVABILITY_OPENTELEMETRY_COZELOOP_SERVICE_NAME", default="")}
 
 load_tracer()
 
@@ -129,7 +136,7 @@ a2a_app = init_app(
 
 a2a_app.post("/run_agent", operation_id="run_agent", tags=["mcp"])(run_agent_func)
 a2a_app.get("/agent_card", operation_id="agent_card", tags=["mcp"])(agent_card)
-
+a2a_app.get("/get_cozeloop_space_id", operation_id="get_cozeloop_space_id", tags=["mcp"])(get_cozeloop_space_id)
 
 # === Build mcp server ===
 
@@ -156,6 +163,25 @@ app = FastAPI(
     redoc_url=None
 )
 
+@app.middleware("http")
+async def otel_context_middleware(request, call_next):
+    carrier = {
+        "traceparent": request.headers.get("Traceparent"),
+        "tracestate": request.headers.get("Tracestate"),
+    }
+    logger.debug(f"carrier: {carrier}")
+    if carrier["traceparent"] is None:
+        return await call_next(request)
+    else:
+        ctx = TraceContextTextMapPropagator().extract(carrier=carrier)
+        logger.debug(f"ctx: {ctx}")
+        token = context.attach(ctx)
+        try:
+            response = await call_next(request)
+        finally:
+            context.detach(token)
+    return response
+
 # Mount A2A routes to main app
 for route in a2a_app.routes:
     app.routes.append(route)

veadk/integrations/ve_faas/template/{{cookiecutter.local_dir_name}}/src/requirements.txt

@@ -1 +1,3 @@
-veadk-python
+veadk-python=={{ cookiecutter.veadk_version }}
+fastapi
+uvicorn[standard]

veadk/integrations/ve_faas/template/{{cookiecutter.local_dir_name}}/src/run.sh

@@ -33,8 +33,11 @@ while [[ $# -gt 0 ]]; do
     esac
 done
 
-# in case of deployment deps not installed in user's requirements.txt
-python3 -m pip install uvicorn[standard] fastapi
+# Check if MODEL_AGENT_API_KEY is set
+if [ -z "$MODEL_AGENT_API_KEY" ]; then
+    echo "MODEL_AGENT_API_KEY is not set. Please set it in your environment variables."
+    exit 1
+fi
 
 USE_ADK_WEB=${USE_ADK_WEB:-False}
 

veadk/integrations/ve_faas/ve_faas.py

@@ -152,6 +152,8 @@ class VeFaaS:
                     "GatewayName": gateway_name,
                     "ServiceName": service_name,
                     "UpstreamName": upstream_name,
+                    "EnableKeyAuth": True,
+                    "EnableMcpSession": True,
                 },
                 "TemplateId": self.template_id,
             },

veadk/integrations/ve_faas/web_template/cookiecutter.json

@@ -0,0 +1,17 @@
+{
+  "local_dir_name": "veadk_vefaas_web_proj",
+  "app_name": "simple-blog",
+  "vefaas_application_name": "simple-blog",
+  "veapig_instance_name": "",
+  "veapig_service_name": "",
+  "veapig_upstream_name": "",
+  "use_adk_web": false,
+  "veadk_version": "",
+  "_copy_without_render": [
+    "*.html",
+    "*.css",
+    "*.js",
+    "static/**/*",
+    "templates/**/*"
+  ]
+}

veadk/integrations/ve_faas/web_template/{{cookiecutter.local_dir_name}}/__init__.py

@@ -0,0 +1,13 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# 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.

veadk/integrations/ve_faas/web_template/{{cookiecutter.local_dir_name}}/clean.py

@@ -0,0 +1,23 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# 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.
+
+from veadk.cloud.cloud_app import CloudApp
+
+def main() -> None:
+    cloud_app = CloudApp(vefaas_application_name="{{cookiecutter.vefaas_application_name}}")
+    cloud_app.delete_self()
+
+
+if __name__ == "__main__":
+    main()

veadk/integrations/ve_faas/web_template/{{cookiecutter.local_dir_name}}/config.yaml.example

@@ -0,0 +1,2 @@
+VOLCENGINE_ACCESS_KEY:
+VOLCENGINE_SECRET_KEY:

veadk/integrations/ve_faas/web_template/{{cookiecutter.local_dir_name}}/deploy.py

@@ -0,0 +1,41 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# 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 asyncio
+from pathlib import Path
+
+from veadk.cloud.cloud_agent_engine import CloudAgentEngine
+
+async def main():
+    engine = CloudAgentEngine()
+
+    cloud_app = engine.deploy(
+        path=str(Path(__file__).parent / "src"),
+        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 {{cookiecutter.use_adk_web}}:
+        print(f"Web is running at: {cloud_app.vefaas_endpoint}")
+    else:
+        print(f"Web template does not support use_adk_web=False")
+
+
+if __name__ == "__main__":
+    asyncio.run(main())

veadk/integrations/ve_faas/web_template/{{cookiecutter.local_dir_name}}/src/Dockerfile

@@ -0,0 +1,23 @@
+# 使用官方Python镜像作为基础镜像
+FROM python:3.9-slim
+
+# 设置工作目录
+WORKDIR /app
+
+# 复制依赖文件并安装依赖
+COPY requirements.txt .
+RUN pip install --no-cache-dir -r requirements.txt
+
+# 复制项目文件
+COPY . .
+
+# 设置环境变量
+ENV FLASK_APP=app.py
+ENV FLASK_ENV=production
+ENV PYTHONUNBUFFERED=1
+
+# 暴露端口
+EXPOSE 8000
+
+# 启动命令
+CMD ["bash", "run.sh"]

veadk/integrations/ve_faas/web_template/{{cookiecutter.local_dir_name}}/src/app.py

@@ -0,0 +1,123 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# 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.
+
+from flask import Flask, render_template, request, redirect, url_for, flash, session
+from models import db, Post, User
+from werkzeug.security import generate_password_hash, check_password_hash
+import os
+
+app = Flask(__name__)
+app.config['SECRET_KEY'] = 'your-secret-key-here'
+app.config['SQLALCHEMY_DATABASE_URI'] = 'sqlite:///blog.db'
+app.config['SQLALCHEMY_TRACK_MODIFICATIONS'] = False
+app.instance_path = os.path.join("/tmp", "flask_instance")
+os.makedirs(app.instance_path, exist_ok=True)
+
+db.init_app(app)
+
+# 前台首页
+@app.route('/')
+def index():
+    page = request.args.get('page', 1, type=int)
+    posts = Post.query.order_by(Post.created_at.desc()).paginate(
+        page=page, per_page=5, error_out=False)
+    return render_template('index.html', posts=posts)
+
+# 文章详情页
+@app.route('/post/<int:post_id>')
+def post_detail(post_id):
+    post = Post.query.get_or_404(post_id)
+    return render_template('post.html', post=post)
+
+# 后台登录页
+@app.route('/admin/login', methods=['GET', 'POST'])
+def admin_login():
+    if request.method == 'POST':
+        username = request.form['username']
+        password = request.form['password']
+        
+        user = User.query.filter_by(username=username).first()
+        
+        if user and check_password_hash(user.password, password):
+            session['admin_logged_in'] = True
+            return redirect(url_for('admin_dashboard'))
+        else:
+            flash('用户名或密码错误')
+    
+    return render_template('admin/login.html')
+
+# 后台登出
+@app.route('/admin/logout')
+def admin_logout():
+    session.pop('admin_logged_in', None)
+    return redirect(url_for('admin_login'))
+
+# 后台管理面板
+@app.route('/admin/dashboard')
+def admin_dashboard():
+    if not session.get('admin_logged_in'):
+        return redirect(url_for('admin_login'))
+    
+    post_count = Post.query.count()
+    return render_template('admin/dashboard.html', post_count=post_count)
+
+# 文章管理
+@app.route('/admin/posts')
+def admin_posts():
+    if not session.get('admin_logged_in'):
+        return redirect(url_for('admin_login'))
+    
+    page = request.args.get('page', 1, type=int)
+    posts = Post.query.order_by(Post.created_at.desc()).paginate(
+        page=page, per_page=10, error_out=False)
+    return render_template('admin/posts.html', posts=posts)
+
+# 创建/编辑文章
+@app.route('/admin/post', methods=['GET', 'POST'])
+@app.route('/admin/post/<int:post_id>', methods=['GET', 'POST'])
+def admin_edit_post(post_id=None):
+    if not session.get('admin_logged_in'):
+        return redirect(url_for('admin_login'))
+    
+    if post_id:
+        post = Post.query.get_or_404(post_id)
+    else:
+        post = Post()
+    
+    if request.method == 'POST':
+        post.title = request.form['title']
+        post.content = request.form['content']
+        
+        if post_id is None:
+            db.session.add(post)
+        db.session.commit()
+        flash('文章保存成功')
+        return redirect(url_for('admin_posts'))
+    
+    return render_template('admin/edit_post.html', post=post)
+
+# 删除文章
+@app.route('/admin/post/delete/<int:post_id>', methods=['POST'])
+def admin_delete_post(post_id):
+    if not session.get('admin_logged_in'):
+        return redirect(url_for('admin_login'))
+    
+    post = Post.query.get_or_404(post_id)
+    db.session.delete(post)
+    db.session.commit()
+    flash('文章删除成功')
+    return redirect(url_for('admin_posts'))
+
+if __name__ == '__main__':
+    app.run(debug=True)

veadk/integrations/ve_faas/web_template/{{cookiecutter.local_dir_name}}/src/init_db.py

@@ -0,0 +1,46 @@
+# Copyright (c) 2025 Beijing Volcano Engine Technology Co., Ltd. and/or its affiliates.
+#
+# 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.
+
+from app import app, db
+from models import User
+from werkzeug.security import generate_password_hash
+from sqlalchemy.exc import OperationalError
+
+def init_database():
+    with app.app_context():
+        try:
+            # 创建所有数据库表
+            db.metadata.create_all(bind=db.engine, checkfirst=True)
+            print("数据库表创建成功")
+        except OperationalError as e:
+            if "table already exists" in str(e).lower():
+                print("数据库表已存在，跳过创建")
+            else:
+                print(f"创建数据库表时出错: {e}")
+                raise
+
+        # 创建默认管理员账户（如不存在）
+        if not User.query.filter_by(username='admin').first():
+            admin = User(
+                username='admin',
+                password=generate_password_hash('admin123')
+            )
+            db.session.add(admin)
+            db.session.commit()
+            print("默认管理员账户创建成功")
+        else:
+            print("默认管理员账户已存在，跳过创建")
+
+if __name__ == '__main__':
+    init_database()