diff --git a/README.md b/README.md index 05e2349..d9b8f98 100644 --- a/README.md +++ b/README.md @@ -88,8 +88,9 @@ It includes **agent deployment** and **secure sandboxed tool execution**, and ca │ ├── stream_printing_messages/ # Streaming and printing messages │ ├── structured_output/ # Structured output parsing and validation │ ├── multiagent_concurrent/ # Concurrent multi-agent task execution -│ └── meta_planner_agent/ # Planning agent with tool orchestration +│ └── meta_planner_agent/ # Planning agent with tool orchestration │ +├── sample_template/ # Template for new sample contributions └── README.md ``` diff --git a/README_zh.md b/README_zh.md index b2fb755..84f9735 100644 --- a/README_zh.md +++ b/README_zh.md @@ -88,8 +88,9 @@ AgentScope Runtime 是一个**全面的运行时框架**,主要解决部署和 │ ├── stream_printing_messages/ # 信息流式输出与打印 │ ├── structured_output/ # 结构化输出解析与验证 │ ├── multiagent_concurrent/ # 多 Agent 并发任务执行 -│ └── meta_planner_agent/ # 带工具编排的计划 Agent +│ └── meta_planner_agent/ # 带工具编排的计划 Agent │ +├── sample_template/ # 新样例贡献模板 └── README.md ``` diff --git a/sample_template/README.md b/sample_template/README.md new file mode 100644 index 0000000..ff502f5 --- /dev/null +++ b/sample_template/README.md @@ -0,0 +1,64 @@ +# [Your Sample Name] + +[Brief description of what this sample demonstrates] + +## 🌳 Sample Structure + +### Python Only + +``` +. +├── README.md # Documentation +├── main.py # Entry point +├── requirements.txt # Dependencies +└── ... # Any files if necessary +``` + +### Full‑stack + +``` +. +├── README.md # Documentation +├── backend/ # Backend source code +│ ├── main.py # Backend entry point +│ ├── requirements.txt # Dependencies +│ └── ... # Other files +│ +├── frontend/ # Frontend source code +│ ├── package.json # Frontend dependencies +│ ├── public/ # Static assets (HTML, favicon, etc.) +│ └── src/ # Frontend source +│ └── ... # Other files +└── README.md +``` + +## 📖 Overview + +[Detailed description of the sample, what it demonstrates, and key features] + +## 🚀 Getting Started + +### Prerequisites + +- Python 3.10 or higher +- [Add other prerequisites like API keys, Node.js, etc.] + +### Installation + +```bash +pip install -r requirements.txt +``` + +### Usage + +```bash +python main.py +``` + +[Add usage examples and expected output] + +## 🛠️ Features + +- [Feature 1] +- [Feature 2] +- [Feature 3] diff --git a/sample_template/main.py b/sample_template/main.py new file mode 100644 index 0000000..90ac3de --- /dev/null +++ b/sample_template/main.py @@ -0,0 +1,14 @@ +""" +[Your Sample Name] - Entry Point + +This example demonstrates [brief description]. +""" +import agentscope + +def main(): + """Main function to run the example.""" + print(agentscope.__version__) + + +if __name__ == "__main__": + main() diff --git a/sample_template/requirements.txt b/sample_template/requirements.txt new file mode 100644 index 0000000..4b402c4 --- /dev/null +++ b/sample_template/requirements.txt @@ -0,0 +1 @@ +agentscope