From 8578ad745d70cdc1259b08f1f2f88d0ac4440460 Mon Sep 17 00:00:00 2001 From: Anycodes Date: Fri, 28 Nov 2025 00:39:11 +0800 Subject: [PATCH 1/5] update docs --- README.md | 10 ++++++++++ 1 file changed, 10 insertions(+) diff --git a/README.md b/README.md index 3e4a4f6..6c2ce13 100644 --- a/README.md +++ b/README.md @@ -1,5 +1,15 @@ # AgentRun Python SDK +
+ +[![PyPI version](https://img.shields.io/pypi/v/agentrun-sdk.svg)](https://pypi.org/project/agentrun-sdk/) +[![License](https://img.shields.io/github/license/Serverless-Devs/agentrun-sdk-python.svg)](https://github.com/Serverless-Devs/agentrun-sdk-python/blob/main/LICENSE) +[![Documentation](https://img.shields.io/badge/docs-agent.run-blue.svg)](https://docs.agent.run) +[![GitHub stars](https://img.shields.io/github/stars/Serverless-Devs/agentrun-sdk-python.svg?style=social)](https://github.com/Serverless-Devs/agentrun-sdk-python) +[![GitHub issues](https://img.shields.io/github/issues/Serverless-Devs/agentrun-sdk-python.svg)](https://github.com/Serverless-Devs/agentrun-sdk-python/issues) + +
+ AgentRun Python SDK 是阿里云 AgentRun 服务的 Python 客户端库，提供简洁易用的 API 来管理 AI Agent 运行时环境。 ## ✨ 特性 From 35a3abbc7c8e687dcaed68859e138b4dde70c36f Mon Sep 17 00:00:00 2001 From: Anycodes Date: Fri, 28 Nov 2025 00:41:34 +0800 Subject: [PATCH 2/5] Create CODE_OF_CONDUCT.md Signed-off-by: Anycodes --- CODE_OF_CONDUCT.md | 5 +++++ 1 file changed, 5 insertions(+) create mode 100644 CODE_OF_CONDUCT.md diff --git a/CODE_OF_CONDUCT.md b/CODE_OF_CONDUCT.md new file mode 100644 index 0000000..019fcad --- /dev/null +++ b/CODE_OF_CONDUCT.md @@ -0,0 +1,5 @@ +# Serverless Devs Community Code of Conduct + +Serverless Devs follows the [CNCF Code of Conduct](https://github.com/cncf/foundation/blob/master/code-of-conduct.md). + +In cases of abusive, harassing, or any unacceptable behaviors, please don't hesitate to contact the project team at service@serverlessfans.com. From c702354435e49a6e12cd904bf35104ecbfbc261e Mon Sep 17 00:00:00 2001 From: Anycodes Date: Fri, 28 Nov 2025 00:45:40 +0800 Subject: [PATCH 3/5] Create CONTRIBUTING.md Signed-off-by: Anycodes --- CONTRIBUTING.md | 185 ++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 185 insertions(+) create mode 100644 CONTRIBUTING.md diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md new file mode 100644 index 0000000..86934f3 --- /dev/null +++ b/CONTRIBUTING.md @@ -0,0 +1,185 @@ +# Contributing to Serverless Devs + +It is warmly welcomed if you have interest to hack on Serverless Devs. First, we encourage this kind of willing very much. And here is a list of contributing guide for you. + +## Topics + +- [Contributing to Serverless Devs](#contributing-to-serverless-devs) + - [Topics](#topics) + - [Reporting security issues](#reporting-security-issues) + - [Reporting general issues](#reporting-general-issues) + - [Code and doc contribution](#code-and-doc-contribution) + - [Workspace Preparation](#workspace-preparation) + - [Branch Definition](#branch-definition) + - [Commit Rules](#commit-rules) + - [Commit Message](#commit-message) + - [Commit Content](#commit-content) + - [PR Description](#pr-description) + - [Test case contribution](#test-case-contribution) + - [Package contribution](#package-contribution) + - [Engage to help anything](#engage-to-help-anything) + + + +## Reporting security issues + +Security issues are always treated seriously. As our usual principle, we discourage anyone to spread security issues. If you find a security issue of Serverless Devs, please do not discuss it in public and even do not open a public issue. Instead we encourage you to send us a private email to [liuyu@xmail.tech](mailto:liuyu@xmail.tech) to report this. + +## Reporting general issues + +To be honest, we regard every user of Serverless Devs as a very kind contributor. After experiencing Serverless Devs, you may have some feedback for the project. Then feel free to open an issue via [NEW ISSUE](https://github.com/Serverless-Devs/agentrun-sdk-python/issues/new/choose). + +Since we collaborate project Serverless Devs in a distributed way, we appreciate **WELL-WRITTEN**, **DETAILED**, **EXPLICIT** issue reports. To make the communication more efficient, we wish everyone could search if your issue is an existing one in the searching list. If you find it existing, please add your details in comments under the existing issue instead of opening a brand new one. + +To make the issue details as standard as possible, we setup an [ISSUE TEMPLATE](./.github/ISSUE_TEMPLATE) for issue reporters. Please **BE SURE** to follow the instructions to fill fields in template. + +There are a lot of cases when you could open an issue: + +* bug report +* feature request +* performance issues +* feature proposal +* feature design +* help wanted +* doc incomplete +* test improvement +* any questions on project +* and so on + +Also we must remind that when filling a new issue, please remember to remove the sensitive data from your post. Sensitive data could be password, secret key, network locations, private business data and so on. + +## Code and doc contribution + +Every action to make project Serverless Devs better is encouraged. On GitHub, every improvement for Serverless Devs could be via a PR (short for pull request). + +* If you find a typo, try to fix it! +* If you find a bug, try to fix it! +* If you find some redundant codes, try to remove them! +* If you find some test cases missing, try to add them! +* If you could enhance a feature, please **DO NOT** hesitate! +* If you find code implicit, try to add comments to make it clear! +* If you find code ugly, try to refactor that! +* If you can help to improve documents, it could not be better! +* If you find document incorrect, just do it and fix that! +* ... + +Actually it is impossible to list them completely. Just remember one principle: + +> WE ARE LOOKING FORWARD TO ANY PR FROM YOU. + +Since you are ready to improve Serverless Devs with a PR, we suggest you could take a look at the PR rules here. + +* [Workspace Preparation](#workspace-preparation) +* [Branch Definition](#branch-definition) +* [Commit Rules](#commit-rules) +* [PR Description](#pr-description) + +### Workspace Preparation + +To put forward a PR, we assume you have registered a GitHub ID. Then you could finish the preparation in the following steps: + +1. **FORK** Serverless Devs to your repository. To make this work, you just need to click the button Fork in right-left of [Serverless-Devs/agentrun-sdk-python](https://github.com/Serverless-Devs/agentrun-sdk-python) main page. Then you will end up with your repository in `https://github.com//agentrun-sdk-python`, in which `your-username` is your GitHub username. + +1. **CLONE** your own repository to develop locally. Use `git clone git@github.com:/Serverless-Devs.git` to clone repository to your local machine. Then you can create new branches to finish the change you wish to make. + +1. **Set Remote** upstream to be `git@github.com:Serverless-Devs/agentrun-sdk-python.git` using the following two commands: + +``` +git remote add upstream git@github.com:Serverless-Devs/agentrun-sdk-python.git +git remote set-url --push upstream no-pushing +``` + +With this remote setting, you can check your git remote configuration like this: + +``` +$ git remote -v +origin git@github.com:/agentrun-sdk-python.git (fetch) +origin git@github.com:/agentrun-sdk-python.git (push) +upstream git@github.com:Serverless-Devs/agentrun-sdk-python.git (fetch) +upstream no-pushing (push) +``` + +Adding this, we can easily synchronize local branches with upstream branches. + +### Branch Definition + +Right now we assume every contribution via pull request is for [branch develop](https://github.com/Serverless-Devs/agentrun-sdk-python/tree/develop) in agentrun-sdk-python. Before contributing, be aware of branch definition would help a lot. + +As a contributor, keep in mind again that every contribution via pull request is for branch develop. While in project Serverless Devs, there are several other branches, we generally call them release branches(such as 0.6.0,0.6.1), feature branches, hotfix branches and master branch. + +When officially releasing a version, there will be a release branch and named with the version number. + +After the release, we will merge the commit of the release branch into the master branch. + +When we find that there is a bug in a certain version, we will decide to fix it in a later version or fix it in a specific hotfix version. When we decide to fix the hotfix version, we will checkout the hotfix branch based on the corresponding release branch, perform code repair and verification, and merge it into the develop branch and the master branch. + +For larger features, we will pull out the feature branch for development and verification. + + +### Commit Rules + +Actually in Serverless Devs, we take two rules serious when committing: + +* [Commit Message](#commit-message) +* [Commit Content](#commit-content) + +#### Commit Message + +Commit message could help reviewers better understand what is the purpose of submitted PR. It could help accelerate the code review procedure as well. We encourage contributors to use **EXPLICIT** commit message rather than ambiguous message. In general, we advocate the following commit message type: + +* docs: xxxx. For example, "docs: add docs about agentrun-sdk-python cluster installation". +* feature: xxxx.For example, "feature: support oracle in AT mode". +* bugfix: xxxx. For example, "bugfix: fix panic when input nil parameter". +* refactor: xxxx. For example, "refactor: simplify to make codes more readable". +* test: xxx. For example, "test: add unit test case for func InsertIntoArray". +* other readable and explicit expression ways. + +On the other side, we discourage contributors from committing message like the following ways: + +* ~~fix bug~~ +* ~~update~~ +* ~~add doc~~ + +If you get lost, please see [How to Write a Git Commit Message](http://chris.beams.io/posts/git-commit/) for a start. + +#### Commit Content + +Commit content represents all content changes included in one commit. We had better include things in one single commit which could support reviewer's complete review without any other commits' help. In another word, contents in one single commit can pass the CI to avoid code mess. In brief, there are three minor rules for us to keep in mind: + +* avoid very large change in a commit; +* complete and reviewable for each commit. +* check git config(`user.name`, `user.email`) when committing to ensure that it is associated with your github ID. +* when submitting pr, please add a brief description of the current changes to the X.X.X.md file under the 'changes/' folder + + +In addition, in the code change part, we suggest that all contributors should read the [code style of agentrun-sdk-python](#code-style). + +No matter commit message, or commit content, we do take more emphasis on code review. + + +### PR Description + +PR is the only way to make change to Serverless Devs project files. To help reviewers better get your purpose, PR description could not be too detailed. We encourage contributors to follow the [PR template](./.github/PULL_REQUEST_TEMPLATE.md) to finish the pull request. + +## Test case contribution + +Any test case would be welcomed. Currently, Serverless Devs function test cases are high priority. + +* For unit test, you need to create a test file named `xxx-xxx.test.ts` in the test directory of the same module. Recommend you to use the [Jest](https://jestjs.io/) UT framework + +* For integration test, you can put the integration test in the test directory or the Serverless Devs-test module. It is recommended to use mock-related test frameworks. + +## Engage to help anything + +We choose GitHub as the primary place for agentrun-sdk-python to collaborate. So the latest updates of agentrun-sdk-python are always here. Although contributions via PR is an explicit way to help, we still call for any other ways. + +* reply to other's issues if you could; +* help solve other user's problems; +* help review other's PR design; +* help review other's codes in PR; +* discuss about agentrun-sdk-python to make things clearer; +* advocate Serverless Devs technology beyond GitHub; +* write blogs on agentrun-sdk-python and so on. + + +In a word, **ANY HELP IS CONTRIBUTION.** From 5c9439c0a14436c105c6e994a459239e4c2b6ead Mon Sep 17 00:00:00 2001 From: Anycodes Date: Fri, 28 Nov 2025 00:46:56 +0800 Subject: [PATCH 4/5] Update copyright year and owner in LICENSE file Signed-off-by: Anycodes --- LICENSE | 201 ++++++++++++++++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 201 insertions(+) create mode 100644 LICENSE diff --git a/LICENSE b/LICENSE new file mode 100644 index 0000000..3a654d2 --- /dev/null +++ b/LICENSE @@ -0,0 +1,201 @@ + 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 2025 Serverless Devs + + 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. From 2b814c7f9b81df8dea23d6c29ac2d3684fb8d166 Mon Sep 17 00:00:00 2001 From: Anycodes Date: Fri, 28 Nov 2025 00:51:45 +0800 Subject: [PATCH 5/5] Create pull request template for contributions Added a pull request template to guide contributors in providing necessary information and tasks. Signed-off-by: Anycodes --- PULL_REQUEST_TEMPLATE.md | 47 ++++++++++++++++++++++++++++++++++++++++ 1 file changed, 47 insertions(+) create mode 100644 PULL_REQUEST_TEMPLATE.md diff --git a/PULL_REQUEST_TEMPLATE.md b/PULL_REQUEST_TEMPLATE.md new file mode 100644 index 0000000..5322235 --- /dev/null +++ b/PULL_REQUEST_TEMPLATE.md @@ -0,0 +1,47 @@ +> Thank you for creating a pull request to contribute to Serverless Devs agentrun-sdk-python code! Before you open the request please answer the following questions to help it be more easily integrated. Please check the boxes "[ ]" with "[x]" when done too. +> Please select one of the PR types below to complete + +--------------------- + +## Fix bugs + +**Bug detail** +> The specific manifestation of the bug or the associated issue. + +**Pull request tasks** +- [ ] Add test cases for the changes +- [ ] Passed the CI test + +--------------------- + +## Update docs + +**Reason for update** +> Why do you need to update your documentation? + +**Pull request tasks** +- [ ] Update Chinese documentation +- [ ] Update English documentation + +--------------------- + +## Add contributor + +**Contributed content** +- [ ] Code +- [ ] Document + +**Content detail** +``` +if content_type == 'code' || content_type == 'document': + please tell us `PR url`，like: https://github.com/Serverless-Devs/agentrun-sdk-python/pull/1 +else: + please describe your contribution in detail +``` + +--------------------- + +## Others + +**Reason for update** +> Why do you need to update your documentation?