veadk-python 0.2.27__py3-none-any.whl

veadk/utils/volcengine_sign.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.
+
+import datetime
+import hashlib
+import hmac
+from urllib.parse import quote
+
+import requests
+
+Service = ""
+Version = ""
+Region = ""
+Host = ""
+ContentType = ""
+
+
+def norm_query(params):
+    query = ""
+    for key in sorted(params.keys()):
+        if isinstance(params[key], list):
+            for k in params[key]:
+                query = (
+                    query + quote(key, safe="-_.~") + "=" + quote(k, safe="-_.~") + "&"
+                )
+        else:
+            query = (
+                query
+                + quote(key, safe="-_.~")
+                + "="
+                + quote(params[key], safe="-_.~")
+                + "&"
+            )
+    query = query[:-1]
+    return query.replace("+", "%20")
+
+
+# 第一步：准备辅助函数。
+# sha256 非对称加密
+def hmac_sha256(key: bytes, content: str):
+    return hmac.new(key, content.encode("utf-8"), hashlib.sha256).digest()
+
+
+# sha256 hash算法
+def hash_sha256(content: str):
+    return hashlib.sha256(content.encode("utf-8")).hexdigest()
+
+
+# 第二步：签名请求函数
+def request(method, date, query, header, ak, sk, action, body):
+    # 第三步：创建身份证明。其中的 Service 和 Region 字段是固定的。ak 和 sk 分别代表
+    # AccessKeyID 和 SecretAccessKey。同时需要初始化签名结构体。一些签名计算时需要的属性也在这里处理。
+    # 初始化身份证明结构体
+    credential = {
+        "access_key_id": ak,
+        "secret_access_key": sk,
+        "service": Service,
+        "region": Region,
+    }
+    # 初始化签名结构体
+    request_param = {
+        "body": body,
+        "host": Host,
+        "path": "/",
+        "method": method,
+        "content_type": ContentType,
+        "date": date,
+        "query": {"Action": action, "Version": Version, **query},
+    }
+    if body is None:
+        request_param["body"] = ""
+    # 第四步：接下来开始计算签名。在计算签名前，先准备好用于接收签算结果的 signResult 变量，并设置一些参数。
+    # 初始化签名结果的结构体
+    x_date = request_param["date"].strftime("%Y%m%dT%H%M%SZ")
+    short_x_date = x_date[:8]
+    x_content_sha256 = hash_sha256(request_param["body"])
+    sign_result = {
+        "Host": request_param["host"],
+        "X-Content-Sha256": x_content_sha256,
+        "X-Date": x_date,
+        "Content-Type": request_param["content_type"],
+    }
+    # 第五步：计算 Signature 签名。
+    signed_headers_str = ";".join(
+        ["content-type", "host", "x-content-sha256", "x-date"]
+    )
+    # signed_headers_str = signed_headers_str + ";x-security-token"
+    canonical_request_str = "\n".join(
+        [
+            request_param["method"].upper(),
+            request_param["path"],
+            norm_query(request_param["query"]),
+            "\n".join(
+                [
+                    "content-type:" + request_param["content_type"],
+                    "host:" + request_param["host"],
+                    "x-content-sha256:" + x_content_sha256,
+                    "x-date:" + x_date,
+                ]
+            ),
+            "",
+            signed_headers_str,
+            x_content_sha256,
+        ]
+    )
+
+    # 打印正规化的请求用于调试比对
+    # print(canonical_request_str)
+    hashed_canonical_request = hash_sha256(canonical_request_str)
+
+    # 打印hash值用于调试比对
+    # print(hashed_canonical_request)
+    credential_scope = "/".join(
+        [short_x_date, credential["region"], credential["service"], "request"]
+    )
+    string_to_sign = "\n".join(
+        ["HMAC-SHA256", x_date, credential_scope, hashed_canonical_request]
+    )
+
+    # 打印最终计算的签名字符串用于调试比对
+    # print(string_to_sign)
+    k_date = hmac_sha256(credential["secret_access_key"].encode("utf-8"), short_x_date)
+    k_region = hmac_sha256(k_date, credential["region"])
+    k_service = hmac_sha256(k_region, credential["service"])
+    k_signing = hmac_sha256(k_service, "request")
+    signature = hmac_sha256(k_signing, string_to_sign).hex()
+
+    sign_result["Authorization"] = (
+        "HMAC-SHA256 Credential={}, SignedHeaders={}, Signature={}".format(
+            credential["access_key_id"] + "/" + credential_scope,
+            signed_headers_str,
+            signature,
+        )
+    )
+    header = {**header, **sign_result}
+    if "X-Security-Token" in header and header["X-Security-Token"] == "":
+        del header["X-Security-Token"]
+    # header = {**header, **{"X-Security-Token": SessionToken}}
+    # 第六步：将 Signature 签名写入 HTTP Header 中，并发送 HTTP 请求。
+    r = requests.request(
+        method=method,
+        url="https://{}{}".format(request_param["host"], request_param["path"]),
+        headers=header,
+        params=request_param["query"],
+        data=request_param["body"],
+    )
+    try:
+        return r.json()
+    except Exception:
+        raise ValueError(f"Error occurred. Bad response: {r}")
+
+
+def ve_request(
+    request_body: dict,
+    action: str,
+    ak: str,
+    sk: str,
+    service: str,
+    version: str,
+    region: str,
+    host: str,
+    content_type: str = "application/json",
+    header: dict = {},
+):
+    # response_body = request("Get", datetime.datetime.utcnow(), {}, {}, AK, SK, "ListUsers", None)
+    # print(response_body)
+    # 以下参数视服务不同而不同，一个服务内通常是一致的
+    global Service
+    Service = service
+    global Version
+    Version = version
+    global Region
+    Region = region
+    global Host
+    Host = host
+    global ContentType
+    ContentType = content_type
+
+    AK = ak
+    SK = sk
+
+    now = datetime.datetime.utcnow()
+
+    # Body的格式需要配合Content-Type，API使用的类型请阅读具体的官方文档，如:json格式需要json.dumps(obj)
+    # response_body = request("GET", now, {"Limit": "2"}, {}, AK, SK, "ListUsers", None)
+    import json
+
+    try:
+        response_body = request(
+            "POST", now, {}, header, AK, SK, action, json.dumps(request_body)
+        )
+        return response_body
+    except Exception as e:
+        raise e

veadk/version.py

@@ -0,0 +1,15 @@
+# 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.
+
+VERSION = "0.2.27"

veadk_python-0.2.27.dist-info/METADATA

@@ -0,0 +1,373 @@
+Metadata-Version: 2.4
+Name: veadk-python
+Version: 0.2.27
+Summary: Volcengine agent development kit, integrations with Volcengine cloud services.
+Author-email: Yaozheng Fang <fangyozheng@gmail.com>, Guodong Li <cu.eric.lee@gmail.com>, Zhi Han <sliverydayday@gmail.com>, Meng Wang <mengwangwm@gmail.com>
+License:                                  Apache License
+                                   Version 2.0, January 2004
+                                http://www.apache.org/licenses/
+        
+           TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION
+        
+           1. Definitions.
+        
+              "License" shall mean the terms and conditions for use, reproduction,
+              and distribution as defined by Sections 1 through 9 of this document.
+        
+              "Licensor" shall mean the copyright owner or entity authorized by
+              the copyright owner that is granting the License.
+        
+              "Legal Entity" shall mean the union of the acting entity and all
+              other entities that control, are controlled by, or are under common
+              control with that entity. For the purposes of this definition,
+              "control" means (i) the power, direct or indirect, to cause the
+              direction or management of such entity, whether by contract or
+              otherwise, or (ii) ownership of fifty percent (50%) or more of the
+              outstanding shares, or (iii) beneficial ownership of such entity.
+        
+              "You" (or "Your") shall mean an individual or Legal Entity
+              exercising permissions granted by this License.
+        
+              "Source" form shall mean the preferred form for making modifications,
+              including but not limited to software source code, documentation
+              source, and configuration files.
+        
+              "Object" form shall mean any form resulting from mechanical
+              transformation or translation of a Source form, including but
+              not limited to compiled object code, generated documentation,
+              and conversions to other media types.
+        
+              "Work" shall mean the work of authorship, whether in Source or
+              Object form, made available under the License, as indicated by a
+              copyright notice that is included in or attached to the work
+              (an example is provided in the Appendix below).
+        
+              "Derivative Works" shall mean any work, whether in Source or Object
+              form, that is based on (or derived from) the Work and for which the
+              editorial revisions, annotations, elaborations, or other modifications
+              represent, as a whole, an original work of authorship. For the purposes
+              of this License, Derivative Works shall not include works that remain
+              separable from, or merely link (or bind by name) to the interfaces of,
+              the Work and Derivative Works thereof.
+        
+              "Contribution" shall mean any work of authorship, including
+              the original version of the Work and any modifications or additions
+              to that Work or Derivative Works thereof, that is intentionally
+              submitted to Licensor for inclusion in the Work by the copyright owner
+              or by an individual or Legal Entity authorized to submit on behalf of
+              the copyright owner. For the purposes of this definition, "submitted"
+              means any form of electronic, verbal, or written communication sent
+              to the Licensor or its representatives, including but not limited to
+              communication on electronic mailing lists, source code control systems,
+              and issue tracking systems that are managed by, or on behalf of, the
+              Licensor for the purpose of discussing and improving the Work, but
+              excluding communication that is conspicuously marked or otherwise
+              designated in writing by the copyright owner as "Not a Contribution."
+        
+              "Contributor" shall mean Licensor and any individual or Legal Entity
+              on behalf of whom a Contribution has been received by Licensor and
+              subsequently incorporated within the Work.
+        
+           2. Grant of Copyright License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              copyright license to reproduce, prepare Derivative Works of,
+              publicly display, publicly perform, sublicense, and distribute the
+              Work and such Derivative Works in Source or Object form.
+        
+           3. Grant of Patent License. Subject to the terms and conditions of
+              this License, each Contributor hereby grants to You a perpetual,
+              worldwide, non-exclusive, no-charge, royalty-free, irrevocable
+              (except as stated in this section) patent license to make, have made,
+              use, offer to sell, sell, import, and otherwise transfer the Work,
+              where such license applies only to those patent claims licensable
+              by such Contributor that are necessarily infringed by their
+              Contribution(s) alone or by combination of their Contribution(s)
+              with the Work to which such Contribution(s) was submitted. If You
+              institute patent litigation against any entity (including a
+              cross-claim or counterclaim in a lawsuit) alleging that the Work
+              or a Contribution incorporated within the Work constitutes direct
+              or contributory patent infringement, then any patent licenses
+              granted to You under this License for that Work shall terminate
+              as of the date such litigation is filed.
+        
+           4. Redistribution. You may reproduce and distribute copies of the
+              Work or Derivative Works thereof in any medium, with or without
+              modifications, and in Source or Object form, provided that You
+              meet the following conditions:
+        
+              (a) You must give any other recipients of the Work or
+                  Derivative Works a copy of this License; and
+        
+              (b) You must cause any modified files to carry prominent notices
+                  stating that You changed the files; and
+        
+              (c) You must retain, in the Source form of any Derivative Works
+                  that You distribute, all copyright, patent, trademark, and
+                  attribution notices from the Source form of the Work,
+                  excluding those notices that do not pertain to any part of
+                  the Derivative Works; and
+        
+              (d) If the Work includes a "NOTICE" text file as part of its
+                  distribution, then any Derivative Works that You distribute must
+                  include a readable copy of the attribution notices contained
+                  within such NOTICE file, excluding those notices that do not
+                  pertain to any part of the Derivative Works, in at least one
+                  of the following places: within a NOTICE text file distributed
+                  as part of the Derivative Works; within the Source form or
+                  documentation, if provided along with the Derivative Works; or,
+                  within a display generated by the Derivative Works, if and
+                  wherever such third-party notices normally appear. The contents
+                  of the NOTICE file are for informational purposes only and
+                  do not modify the License. You may add Your own attribution
+                  notices within Derivative Works that You distribute, alongside
+                  or as an addendum to the NOTICE text from the Work, provided
+                  that such additional attribution notices cannot be construed
+                  as modifying the License.
+        
+              You may add Your own copyright statement to Your modifications and
+              may provide additional or different license terms and conditions
+              for use, reproduction, or distribution of Your modifications, or
+              for any such Derivative Works as a whole, provided Your use,
+              reproduction, and distribution of the Work otherwise complies with
+              the conditions stated in this License.
+        
+           5. Submission of Contributions. Unless You explicitly state otherwise,
+              any Contribution intentionally submitted for inclusion in the Work
+              by You to the Licensor shall be under the terms and conditions of
+              this License, without any additional terms or conditions.
+              Notwithstanding the above, nothing herein shall supersede or modify
+              the terms of any separate license agreement you may have executed
+              with Licensor regarding such Contributions.
+        
+           6. Trademarks. This License does not grant permission to use the trade
+              names, trademarks, service marks, or product names of the Licensor,
+              except as required for reasonable and customary use in describing the
+              origin of the Work and reproducing the content of the NOTICE file.
+        
+           7. Disclaimer of Warranty. Unless required by applicable law or
+              agreed to in writing, Licensor provides the Work (and each
+              Contributor provides its Contributions) on an "AS IS" BASIS,
+              WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or
+              implied, including, without limitation, any warranties or conditions
+              of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A
+              PARTICULAR PURPOSE. You are solely responsible for determining the
+              appropriateness of using or redistributing the Work and assume any
+              risks associated with Your exercise of permissions under this License.
+        
+           8. Limitation of Liability. In no event and under no legal theory,
+              whether in tort (including negligence), contract, or otherwise,
+              unless required by applicable law (such as deliberate and grossly
+              negligent acts) or agreed to in writing, shall any Contributor be
+              liable to You for damages, including any direct, indirect, special,
+              incidental, or consequential damages of any character arising as a
+              result of this License or out of the use or inability to use the
+              Work (including but not limited to damages for loss of goodwill,
+              work stoppage, computer failure or malfunction, or any and all
+              other commercial damages or losses), even if such Contributor
+              has been advised of the possibility of such damages.
+        
+           9. Accepting Warranty or Additional Liability. While redistributing
+              the Work or Derivative Works thereof, You may choose to offer,
+              and charge a fee for, acceptance of support, warranty, indemnity,
+              or other liability obligations and/or rights consistent with this
+              License. However, in accepting such obligations, You may act only
+              on Your own behalf and on Your sole responsibility, not on behalf
+              of any other Contributor, and only if You agree to indemnify,
+              defend, and hold each Contributor harmless for any liability
+              incurred by, or claims asserted against, such Contributor by reason
+              of your accepting any such warranty or additional liability.
+        
+           END OF TERMS AND CONDITIONS
+        
+           APPENDIX: How to apply the Apache License to your work.
+        
+              To apply the Apache License to your work, attach the following
+              boilerplate notice, with the fields enclosed by brackets "[]"
+              replaced with your own identifying information. (Don't include
+              the brackets!)  The text should be enclosed in the appropriate
+              comment syntax for the file format. We also recommend that a
+              file or class name and description of purpose be included on the
+              same "printed page" as the copyright notice for easier
+              identification within third-party archives.
+        
+           Copyright [yyyy] [name of copyright owner]
+        
+           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.
+        
+Requires-Python: >=3.10
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Requires-Dist: pydantic-settings>=2.10.1
+Requires-Dist: a2a-sdk>=0.3.0
+Requires-Dist: deprecated>=1.2.18
+Requires-Dist: google-adk>=1.10.0
+Requires-Dist: litellm>=1.74.3
+Requires-Dist: loguru>=0.7.3
+Requires-Dist: opentelemetry-exporter-otlp>=1.35.0
+Requires-Dist: opentelemetry-instrumentation-logging>=0.56b0
+Requires-Dist: wrapt>=1.17.2
+Requires-Dist: openai<1.100
+Requires-Dist: volcengine-python-sdk>=4.0.33
+Requires-Dist: volcengine>=1.0.193
+Requires-Dist: agent-pilot-sdk>=0.1.2
+Requires-Dist: fastmcp>=2.11.3
+Requires-Dist: cookiecutter>=2.6.0
+Requires-Dist: omegaconf>=2.3.0
+Requires-Dist: llama-index>=0.14.0
+Requires-Dist: llama-index-embeddings-openai-like>=0.2.2
+Requires-Dist: llama-index-llms-openai-like>=0.5.1
+Requires-Dist: llama-index-vector-stores-opensearch>=0.6.1
+Requires-Dist: psycopg2-binary>=2.9.10
+Requires-Dist: asyncpg>=0.29.0
+Requires-Dist: pymysql>=1.1.1
+Requires-Dist: aiomysql>=0.3.2
+Requires-Dist: opensearch-py==2.8.0
+Requires-Dist: filetype>=1.2.0
+Provides-Extra: extensions
+Requires-Dist: redis>=5.0; extra == "extensions"
+Requires-Dist: tos>=2.8.4; extra == "extensions"
+Requires-Dist: llama-index-vector-stores-redis>=0.6.1; extra == "extensions"
+Provides-Extra: database
+Requires-Dist: redis>=5.0; extra == "database"
+Requires-Dist: pymysql>=1.1.1; extra == "database"
+Requires-Dist: volcengine>=1.0.193; extra == "database"
+Requires-Dist: tos>=2.8.4; extra == "database"
+Requires-Dist: mem0ai==0.1.118; extra == "database"
+Provides-Extra: speech
+Provides-Extra: eval
+Requires-Dist: prometheus-client>=0.22.1; extra == "eval"
+Requires-Dist: deepeval>=3.2.6; extra == "eval"
+Requires-Dist: google-adk[eval]; extra == "eval"
+Provides-Extra: cli
+Provides-Extra: dev
+Requires-Dist: pre-commit>=4.2.0; extra == "dev"
+Requires-Dist: pytest>=8.4.1; extra == "dev"
+Requires-Dist: pytest-asyncio>=1.0.0; extra == "dev"
+Requires-Dist: pytest-xdist>=3.8.0; extra == "dev"
+Dynamic: license-file
+
+<p align="center">
+    <img src="assets/images/logo.png" alt="Volcengine Agent Development Kit Logo" width="50%">
+</p>
+
+# Volcengine Agent Development Kit
+
+[![License](https://img.shields.io/badge/License-Apache_2.0-blue.svg)](LICENSE)
+[![Deepwiki](https://deepwiki.com/badge.svg)](https://deepwiki.com/volcengine/veadk-python)
+
+An open-source kit for agent development, integrated the powerful capabilities of Volcengine.
+
+For more details, see our [documents](https://volcengine.github.io/veadk-python/).
+
+A [tutorial](https://github.com/volcengine/veadk-python/blob/main/veadk_tutorial.ipynb) is available by Jupyter Notebook, or open it in [Google Colab](https://colab.research.google.com/github/volcengine/veadk-python/blob/main/veadk_tutorial.ipynb) directly.
+
+## Installation
+
+### From PyPI
+
+```python
+pip install veadk-python
+
+# install extensions
+pip install veadk-python[extensions]
+```
+
+### Build from source
+
+We use `uv` to build this project ([how-to-install-uv](https://docs.astral.sh/uv/getting-started/installation/)).
+
+```bash
+git clone ... # clone repo first
+
+cd veadk-python
+
+uv venv --python 3.10
+
+# only install necessary requirements
+uv sync
+
+# or, install extra requirements
+# uv sync --extra database
+# uv sync --extra eval
+# uv sync --extra cli
+
+# or, directly install all requirements
+# uv sync --all-extras
+
+# install veadk-python with editable mode
+uv pip install -e .
+```
+
+## Configuration
+
+We recommand you to create a `config.yaml` file in the root directory of your own project, `VeADK` is able to read it automatically. For running a minimal agent, you just need to set the following configs in your `config.yaml` file:
+
+```yaml
+model:
+  agent:
+    provider: openai
+    name: doubao-seed-1-6-250615
+    api_base: https://ark.cn-beijing.volces.com/api/v3/
+    api_key: # <-- set your Volcengine ARK api key here
+```
+
+You can refer to the [config instructions](https://volcengine.github.io/veadk-python/installation.html#%E9%85%8D%E7%BD%AE) for more details.
+
+## Have a try
+
+Enjoy a minimal agent from VeADK:
+
+```python
+from veadk import Agent
+import asyncio
+
+agent = Agent()
+
+res = asyncio.run(agent.run("hello!"))
+print(res)
+```
+
+## Command line tools
+
+VeADK provides several useful command line tools for faster deployment and optimization, such as:
+
+- `veadk deploy`: deploy your project to [Volcengine VeFaaS platform](https://www.volcengine.com/product/vefaas) (you can use `veadk init` to init a demo project first)
+- `veadk prompt`: otpimize the system prompt of your agent by [PromptPilot](https://promptpilot.volcengine.com)
+
+## Contribution
+
+Before making your contribution to our repository, please install and config the `pre-commit` linter first.
+
+```bash
+pip install pre-commit
+pre-commit install
+```
+
+Before commit or push your changes, please make sure the unittests are passed ,otherwise your PR will be rejected by CI/CD workflow. Running the unittests by:
+
+```bash
+pytest -n 16
+```
+
+## Contact with us
+
+Join our discussion group by scanning the QR code below:
+
+<p align="center">
+    <img src="assets/images/veadk_group_qrcode.jpg" alt="Volcengine Agent Development Kit Logo" width="40%">
+</p>
+
+## License
+
+This project is licensed under the [Apache 2.0 License](./LICENSE).