From 38a7e49d035b5053df52f00a02047af914d2729b Mon Sep 17 00:00:00 2001 From: raykkk Date: Wed, 29 Oct 2025 12:10:18 +0800 Subject: [PATCH 1/3] add project template --- project_template/README.md | 64 +++++++++++++++++++++++++++++++ project_template/main.py | 14 +++++++ project_template/requirements.txt | 1 + 3 files changed, 79 insertions(+) create mode 100644 project_template/README.md create mode 100644 project_template/main.py create mode 100644 project_template/requirements.txt diff --git a/project_template/README.md b/project_template/README.md new file mode 100644 index 0000000..b9b1ca4 --- /dev/null +++ b/project_template/README.md @@ -0,0 +1,64 @@ +# [Your Project Name] + +[Brief description of what this project demonstrates] + +## ๐ŸŒณ Project 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.text # 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 project, 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/project_template/main.py b/project_template/main.py new file mode 100644 index 0000000..70714bf --- /dev/null +++ b/project_template/main.py @@ -0,0 +1,14 @@ +""" +[Your Project 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/project_template/requirements.txt b/project_template/requirements.txt new file mode 100644 index 0000000..4b402c4 --- /dev/null +++ b/project_template/requirements.txt @@ -0,0 +1 @@ +agentscope From c35c1187b2abe73b761062daa023ad80b678e740 Mon Sep 17 00:00:00 2001 From: raykkk Date: Wed, 29 Oct 2025 12:18:04 +0800 Subject: [PATCH 2/3] add project template --- README.md | 3 ++- README_zh.md | 3 ++- {project_template => sample_template}/README.md | 8 ++++---- {project_template => sample_template}/main.py | 2 +- {project_template => sample_template}/requirements.txt | 0 5 files changed, 9 insertions(+), 7 deletions(-) rename {project_template => sample_template}/README.md (87%) rename {project_template => sample_template}/main.py (85%) rename {project_template => sample_template}/requirements.txt (100%) 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/project_template/README.md b/sample_template/README.md similarity index 87% rename from project_template/README.md rename to sample_template/README.md index b9b1ca4..161d432 100644 --- a/project_template/README.md +++ b/sample_template/README.md @@ -1,8 +1,8 @@ -# [Your Project Name] +# [Your Sample Name] -[Brief description of what this project demonstrates] +[Brief description of what this sample demonstrates] -## ๐ŸŒณ Project Structure +## ๐ŸŒณ Sample Structure ### Python Only @@ -34,7 +34,7 @@ ## ๐Ÿ“– Overview -[Detailed description of the project, what it demonstrates, and key features] +[Detailed description of the sample, what it demonstrates, and key features] ## ๐Ÿš€ Getting Started diff --git a/project_template/main.py b/sample_template/main.py similarity index 85% rename from project_template/main.py rename to sample_template/main.py index 70714bf..90ac3de 100644 --- a/project_template/main.py +++ b/sample_template/main.py @@ -1,5 +1,5 @@ """ -[Your Project Name] - Entry Point +[Your Sample Name] - Entry Point This example demonstrates [brief description]. """ diff --git a/project_template/requirements.txt b/sample_template/requirements.txt similarity index 100% rename from project_template/requirements.txt rename to sample_template/requirements.txt From 9bd84ef9b923f2d26e231c2cf5aeb8dee6b0e42e Mon Sep 17 00:00:00 2001 From: raykkk Date: Wed, 29 Oct 2025 12:19:52 +0800 Subject: [PATCH 3/3] add project template --- sample_template/README.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/sample_template/README.md b/sample_template/README.md index 161d432..ff502f5 100644 --- a/sample_template/README.md +++ b/sample_template/README.md @@ -21,7 +21,7 @@ โ”œโ”€โ”€ README.md # Documentation โ”œโ”€โ”€ backend/ # Backend source code โ”‚ โ”œโ”€โ”€ main.py # Backend entry point -โ”‚ โ”œโ”€โ”€ requirements.text # Dependencies +โ”‚ โ”œโ”€โ”€ requirements.txt # Dependencies โ”‚ โ””โ”€โ”€ ... # Other files โ”‚ โ”œโ”€โ”€ frontend/ # Frontend source code