Merge remote-tracking branch 'origin/main' into feat/rag

# Conflicts:
#	pyproject.toml

Author: XGenerationLab

.github/PULL_REQUEST_TEMPLATE.md

@@ -1,11 +1,3 @@
----
-name: Pull Request
-about: Create a pull request for AgentScope Runtime
-title: '[Component] Brief description'
-labels: ''
-assignees: ''
----
-
 ## Description
 [Describe what this PR does and why]
 

.github/release-drafter.yml

@@ -0,0 +1,33 @@
+name-template: 'v$RESOLVED_VERSION 🌈'
+tag-template: 'v$RESOLVED_VERSION'
+categories:
+  - title: '🚀 Features'
+    labels:
+      - 'feature'
+      - 'enhancement'
+      - 'Feature'
+  - title: '🐛 Bug Fixes'
+    labels:
+      - 'fix'
+      - 'bugfix'
+      - 'bug'
+      - 'hotfix'
+exclude-labels:
+  - 'skip-changelog'
+change-template: '- $TITLE @$AUTHOR (#$NUMBER)'
+change-title-escapes: '\<*_&' # You can add # and @ to disable mentions, and add ` to disable code blocks.
+version-resolver:
+  major:
+    labels:
+      - 'major'
+  minor:
+    labels:
+      - 'minor'
+  patch:
+    labels:
+      - 'patch'
+  default: patch
+template: |
+  ## Changes
+
+  $CHANGES

.github/workflows/cookbook.yml

@@ -21,8 +21,7 @@ jobs:
     - name: Install dependencies
       run: |
         python -m pip install --upgrade pip
-        pip install -q -e ".[dev]"
-
+        pip install -q -e ".[dev,sandbox,agentscope,langgraph,agno,a2a,autogen]"
     - name: Add execute permission to build.sh
       run: |
         chmod +x cookbook/build.sh

.github/workflows/unittest.yml

@@ -0,0 +1,59 @@
+name: Unit Tests
+
+
+on:
+  push:
+    branches:
+      - 'main'
+
+
+jobs:
+  test:
+    runs-on: ${{ matrix.os }}
+    strategy:
+      matrix:
+        os: [ ubuntu-latest ]
+        python-version: [ '3.10' ]
+
+
+    steps:
+      - name: Checkout repository
+        uses: actions/checkout@v4
+
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+
+      - name: Cache pip dependencies
+        uses: actions/cache@v4
+        with:
+          path: ~/.cache/pip
+          key: ${{ runner.os }}-pip-${{ hashFiles('**/pyproject.toml') }}
+          restore-keys: |
+            ${{ runner.os }}-pip-
+
+      - name: Update setuptools
+        run: |
+          pip install --upgrade pip
+          pip install setuptools==78.1.1 wheel==0.45.1
+
+      - name: Set PYTHONPATH
+        run: |
+          echo "PYTHONPATH=$PYTHONPATH:${{ github.workspace }}/src" >> $GITHUB_ENV
+
+      - name: Install dependencies
+        run: |
+          export PIP_DEFAULT_TIMEOUT=300
+          pip install -q -e ".[dev,sandbox,agentscope,langgraph,agno,a2a,autogen]"
+
+      - name: Run tests with coverage
+        env:
+          OPENAI_API_KEY: ${{ secrets.OPENAI_API_KEY }}
+          DASHSCOPE_API_KEY: ${{ secrets.DASHSCOPE_API_KEY }}
+        run: |
+          coverage run -m pytest tests
+
+      - name: Generate coverage report
+        run: |
+          coverage report -m

.pre-commit-config.yaml

@@ -32,8 +32,6 @@ repos:
           | \.html$
           )
         args: [
-#          --disallow-untyped-defs,
-#          --disallow-incomplete-defs,
           --ignore-missing-imports,
           --disable-error-code=var-annotated,
           --disable-error-code=union-attr,

README.md

@@ -16,6 +16,7 @@
 [![Discord](https://img.shields.io/badge/Discord-Join_Us-blueviolet.svg?logo=discord)](https://discord.gg/eYMpfnkG8h)
 [![DingTalk](https://img.shields.io/badge/DingTalk-Join_Us-orange.svg)](https://qr.dingtalk.com/action/joingroup?code=v1,k1,OmDlBXpjW+I2vWjKDsjvI9dhcXjGZi3bQiojOq3dlDw=&_dt_no_comment=1&origin=11)
 
+[[Cookbook]](https://runtime.agentscope.io/)
 [[中文README]](README_zh.md)
 
 **A Production-Ready Runtime Framework for Intelligent Agent Applications**
@@ -154,7 +155,7 @@ with BaseSandbox() as box:
 
 > [!NOTE]
 >
-> Current version requires Docker to be installed and running on your system. In the future, we will provide Kubernetes deployment and public cloud deployment options. Please refer to [this tutorial](https://runtime.agentscope.io/en/sandbox.html) for more details.
+> Current version requires Docker or Kubernetes to be installed and running on your system. Please refer to [this tutorial](https://runtime.agentscope.io/en/sandbox.html) for more details.
 
 ---
 
@@ -164,6 +165,7 @@ with BaseSandbox() as box:
 - **[💡 Concept](https://runtime.agentscope.io/en/concept.html)**: Core concepts and architecture overview
 - **[🚀 Quick Start](https://runtime.agentscope.io/en/quickstart.html)**: Quick start tutorial
 - **[🏠 Demo House](https://runtime.agentscope.io/en/demohouse.html)**: Rich example projects
+- **[📋 API Reference](https://runtime.agentscope.io/en/api/index.html)**: Complete API documentation
 
 ---
 
@@ -172,6 +174,7 @@ with BaseSandbox() as box:
 ### AgentScope Integration
 
 ```python
+# pip install "agentscope-runtime[agentscope]"
 import os
 
 from agentscope.agent import ReActAgent
@@ -194,6 +197,7 @@ agent = AgentScopeAgent(
 ### Agno Integration
 
 ```python
+# pip install "agentscope-runtime[agno]"
 from agno.agent import Agent
 from agno.models.openai import OpenAIChat
 from agentscope_runtime.engine.agents.agno_agent import AgnoAgent
@@ -210,9 +214,30 @@ agent = AgnoAgent(
 )
 ```
 
+### AutoGen Integration
+
+```python
+# pip install "agentscope-runtime[autogen]"
+from autogen_agentchat.agents import AssistantAgent
+from autogen_ext.models.openai import OpenAIChatCompletionClient
+from agentscope_runtime.engine.agents.autogen_agent import AutogenAgent
+
+agent = AutogenAgent(
+    name="Friday",
+    model=OpenAIChatCompletionClient(
+        model="gpt-4",
+    ),
+    agent_config={
+        "system_message": "You're a helpful assistant",
+    },
+    agent_builder=AssistantAgent,
+)
+```
+
 ### LangGraph Integration
 
 ```python
+# pip install "agentscope-runtime[langgraph]"
 from typing import TypedDict
 from langgraph import graph, types
 from agentscope_runtime.engine.agents.langgraph_agent import LangGraphAgent

README_zh.md

@@ -16,6 +16,7 @@
 [![Discord](https://img.shields.io/badge/Discord-Join_Us-blueviolet.svg?logo=discord)](https://discord.gg/eYMpfnkG8h)
 [![DingTalk](https://img.shields.io/badge/DingTalk-Join_Us-orange.svg)](https://qr.dingtalk.com/action/joingroup?code=v1,k1,OmDlBXpjW+I2vWjKDsjvI9dhcXjGZi3bQiojOq3dlDw=&_dt_no_comment=1&origin=11)
 
+[[Cookbook]](https://runtime.agentscope.io/)
 [[English README]](README.md)
 
 **智能体应用的生产就绪运行时框架**
@@ -151,7 +152,7 @@ with BaseSandbox() as box:
 
 > [!NOTE]
 >
-> 当前版本需要安装并运行Docker，未来我们将提供Kubernetes部署和公有云部署选项。请参考[此教程](https://runtime.agentscope.io/zh/sandbox.html)了解更多详情。
+> 当前版本需要安装并运行Docker或者Kubernetes，未来我们将提供更多公有云部署选项。请参考[此教程](https://runtime.agentscope.io/zh/sandbox.html)了解更多详情。
 
 ---
 
@@ -161,6 +162,7 @@ with BaseSandbox() as box:
 - **[💡 概念](https://runtime.agentscope.io/zh/concept.html)**: 核心概念和架构概述
 - **[🚀 快速开始](https://runtime.agentscope.io/zh/quickstart.html)**: 快速入门教程
 - **[🏠 展示厅](https://runtime.agentscope.io/zh/demohouse.html)**: 丰富的示例项目
+- **[📋 API 参考](https://runtime.agentscope.io/zh/api/index.html)**: 完整的API文档
 
 ---
 
@@ -169,6 +171,7 @@ with BaseSandbox() as box:
 ### AgentScope 集成
 
 ```python
+# pip install "agentscope-runtime[agentscope]"
 import os
 
 from agentscope.agent import ReActAgent
@@ -191,6 +194,7 @@ agent = AgentScopeAgent(
 ### Agno集成
 
 ```python
+# pip install "agentscope-runtime[agno]"
 from agno.agent import Agent
 from agno.models.openai import OpenAIChat
 from agentscope_runtime.engine.agents.agno_agent import AgnoAgent
@@ -207,9 +211,30 @@ agent = AgnoAgent(
 )
 ```
 
+### AutoGen集成
+
+```python
+# pip install "agentscope-runtime[autogen]"
+from autogen_agentchat.agents import AssistantAgent
+from autogen_ext.models.openai import OpenAIChatCompletionClient
+from agentscope_runtime.engine.agents.autogen_agent import AutogenAgent
+
+agent = AutogenAgent(
+    name="Friday",
+    model=OpenAIChatCompletionClient(
+        model="gpt-4",
+    ),
+    agent_config={
+        "system_message": "You're a helpful assistant",
+    },
+    agent_builder=AssistantAgent,
+)
+```
+
 ### LangGraph集成
 
 ```python
+# pip install "agentscope-runtime[langgraph]"
 from typing import TypedDict
 from langgraph import graph, types
 from agentscope_runtime.engine.agents.langgraph_agent import LangGraphAgent

cookbook/_config.yml

@@ -26,8 +26,48 @@ latex:
 bibtex_bibfiles:
   - references.bib
 
+# Sphinx settings
 sphinx:
+  extra_extensions:
+    - sphinx.ext.autodoc
+    - sphinx.ext.viewcode
+    - sphinx.ext.napoleon
+    - sphinx.ext.intersphinx
+    - sphinx.ext.autosummary
   config:
+    # API Documentation Configuration
+    autosummary_generate: True
+    autosummary_imported_members: True
+
+    # Autodoc Configuration
+    autodoc_typehints: 'description'
+    autodoc_member_order: 'bysource'
+    autodoc_default_options:
+      members: True
+      member-order: 'bysource'
+      special-members: '__init__'
+      undoc-members: True
+      exclude-members: '__weakref__'
+
+    # Napoleon Configuration
+    napoleon_google_docstring: True
+    napoleon_numpy_docstring: True
+    napoleon_include_init_with_doc: False
+    napoleon_include_private_with_doc: False
+    napoleon_include_special_with_doc: True
+    napoleon_use_admonition_for_examples: False
+    napoleon_use_admonition_for_notes: False
+    napoleon_use_admonition_for_references: False
+    napoleon_use_ivar: False
+    napoleon_use_param: True
+    napoleon_use_rtype: True
+
+    # Intersphinx Configuration
+    intersphinx_mapping:
+      python: ['https://docs.python.org/3', null]
+      numpy: ['https://numpy.org/doc/stable/', null]
+
+    # Theme Configuration
     html_theme: furo
     pygments_style: "friendly"
     html_favicon: logo.svg

cookbook/_templates/language-switch.html

@@ -53,8 +53,8 @@
 
         // Define which captions should be displayed based on the selected language
         const languageMapping = {
-            'en': ['English'],
-            'zh': ['简介', '中文']
+            'en': ['Tutorial', 'API Reference' ],
+            'zh': ['简介', '教程', 'API 参考']
         };
 
         const visibleCaptions = languageMapping[lang] || [];

cookbook/_toc.yml

@@ -1,7 +1,7 @@
 format: jb-book
 root: en/intro
 parts:
-- caption: English
+- caption: Tutorial
   numbered: 1
   chapters:
   - file: en/install.md
@@ -24,11 +24,23 @@ parts:
   - file: en/contribute.md
     sections:
     - file: en/README.md
+
+- caption: API Reference
+  chapters:
+  - file: en/api/index.md
+    title: "API Reference"
+    sections:
+    - file: en/api/sandbox.md
+      title: "Sandbox"
+    - file: en/api/engine.md
+      title: "Engine"
+
 - caption: 简介
   chapters:
     - file: zh/intro.md
       title: "0. 介绍"
-- caption: 中文
+
+- caption: 教程
   numbered: 1
   chapters:
   - file: zh/install.md
@@ -50,4 +62,14 @@ parts:
   - file: zh/demohouse.md
   - file: zh/contribute.md
     sections:
-      - file: zh/README.md
+    - file: zh/README.md
+
+- caption: API 参考
+  chapters:
+  - file: zh/api/index.md
+    title: "API 参考"
+    sections:
+    - file: zh/api/sandbox.md
+      title: "Sandbox"
+    - file: zh/api/engine.md
+      title: "Engine"