Merge pull request #15 from rayrayraykk/dev/template

add project template
This commit is contained in:
Osier-Yi
2025-10-29 12:22:16 +08:00
committed by GitHub
5 changed files with 83 additions and 2 deletions

View File

@@ -90,6 +90,7 @@ It includes **agent deployment** and **secure sandboxed tool execution**, and ca
│ ├── multiagent_concurrent/ # Concurrent multi-agent task execution │ ├── 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 └── README.md
``` ```

View File

@@ -90,6 +90,7 @@ AgentScope Runtime 是一个**全面的运行时框架**,主要解决部署和
│ ├── multiagent_concurrent/ # 多 Agent 并发任务执行 │ ├── multiagent_concurrent/ # 多 Agent 并发任务执行
│ └── meta_planner_agent/ # 带工具编排的计划 Agent │ └── meta_planner_agent/ # 带工具编排的计划 Agent
├── sample_template/ # 新样例贡献模板
└── README.md └── README.md
``` ```

64
sample_template/README.md Normal file
View File

@@ -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
```
### Fullstack
```
.
├── 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]

14
sample_template/main.py Normal file
View File

@@ -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()

View File

@@ -0,0 +1 @@
agentscope