base-agentkit 0.1.0__tar.gz

base_agentkit-0.1.0/LICENSE

@@ -0,0 +1,183 @@
+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 [yyyy] [name of copyright owner]
+
+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.

base_agentkit-0.1.0/PKG-INFO

@@ -0,0 +1,142 @@
+Metadata-Version: 2.4
+Name: base-agentkit
+Version: 0.1.0
+Summary: Workspace-isolated Python framework for building tool-using LLM agents.
+Keywords: agents,llm,tool-calling,workspace,ai
+Author: sii-nyc
+Author-email: sii-nyc <253108120111@sii.edu.cn>
+License-Expression: Apache-2.0
+License-File: LICENSE
+Classifier: Development Status :: 3 - Alpha
+Classifier: Intended Audience :: Developers
+Classifier: License :: OSI Approved :: Apache Software License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Typing :: Typed
+Requires-Dist: openai>=2.21.0
+Requires-Dist: pydantic>=2.12.5
+Requires-Dist: pyyaml>=6.0.3
+Requires-Dist: requests>=2.32.5
+Requires-Python: >=3.12
+Project-URL: Homepage, https://github.com/Inkjourney/agentkit
+Project-URL: Repository, https://github.com/Inkjourney/agentkit
+Project-URL: Documentation, https://github.com/Inkjourney/agentkit/tree/main/docs/agentkit
+Project-URL: Issues, https://github.com/Inkjourney/agentkit/issues
+Description-Content-Type: text/markdown
+
+# AgentKit
+
+一个基于 LLM 的通用 Agent 框架，支持 workspace 隔离、统一 LLM 抽象、工具调用循环、CLI 与 Python SDK。
+
+## 当前能力
+
+- workspace 强隔离：所有读写通过 `WorkspaceFS`
+- 统一 LLM 抽象：`ConversationItem` / `ConversationState` / `UnifiedLLMRequest` / `UnifiedLLMResponse`
+- Provider 支持（同步、非流式、文本）
+  - OpenAI (`responses` / `chat_completions`)
+  - Anthropic (`messages`)
+  - Gemini (`generateContent`)
+  - Qwen（OpenAI-compatible `chat_completions`）
+  - vLLM（OpenAI-compatible `chat_completions`）
+- 工具系统：注册式工具机制，工具模块放在 `src/agentkit/tools/library/`
+- Agent loop：模型推理与工具执行闭环，受 step/time budget 约束
+- runlog：每次任务写入 `workspace/logs/run_<run_id>.jsonl`
+
+## 状态
+
+- 当前仓库包含针对 Agent loop、CLI、工具系统、runlog 以及 OpenAI / Anthropic / Gemini / Qwen / vLLM provider 适配层的单元测试
+- 尚未提供针对真实上游 API 的集成 smoke test，因此正式发布前仍建议用目标模型做一次端到端验证
+
+## 文档
+
+详细使用说明和完整文档见 `docs/agentkit/`。
+
+## 从源码安装
+
+```bash
+uv sync
+uv run agentkit --help
+```
+
+## 从 PyPI 安装
+
+```bash
+pip install base-agentkit
+agentkit --help
+```
+
+安装后的导入路径和 CLI 名称保持不变：
+
+```python
+from agentkit import create_agent
+```
+
+## 配置示例
+
+### vLLM
+
+```yaml
+workspace:
+  root: "./vllm_workspace"
+
+provider:
+  kind: "vllm"
+  model: "glm-5"
+  openai_api_variant: "chat_completions"
+  conversation_mode: "auto"
+  base_url: "http://localhost:8000/v1"
+  api_key: "empty"
+  temperature: 0.8
+  timeout_s: 600
+  retries: 2
+  enable_thinking: true
+
+agent:
+  system_prompt: "You are a helpful agent. Use tools when needed."
+  budget:
+    max_steps: 200
+    time_budget_s: 1800
+    max_input_chars: 180000
+
+tools:
+  allowed:
+    - "view"
+    - "create_file"
+    - "str_replace"
+    - "word_count"
+
+runlog:
+  enabled: true
+  redact: true
+  max_text_chars: 20000
+```
+
+## CLI 运行
+
+```bash
+export OPENAI_API_KEY="your-key"
+uv run agentkit --config path/to/config.yaml run --task "列出当前 workspace 的文件"
+```
+
+## Python SDK
+
+```python
+from agentkit import create_agent
+
+agent = create_agent("path/to/config.yaml")
+report = agent.run("在 workspace 里新建 notes/todo.txt 并写入今天计划")
+print(report.final_output)
+```
+
+## 项目结构
+
+核心实现位于 `src/agentkit/`：
+
+- `config/`: 配置结构与加载
+- `workspace/`: 强隔离文件系统和目录布局
+- `llm/`: 统一抽象、provider base/factory 与四平台 adapter
+- `tools/`: 工具抽象、注册表与自动加载
+- `agent/`: budget、report、runtime、Agent loop
+- `runlog/`: 结构化事件、event sink 与 JSONL runlog
+- `cli/`: 命令行入口

base_agentkit-0.1.0/README.md

@@ -0,0 +1,115 @@
+# AgentKit
+
+一个基于 LLM 的通用 Agent 框架，支持 workspace 隔离、统一 LLM 抽象、工具调用循环、CLI 与 Python SDK。
+
+## 当前能力
+
+- workspace 强隔离：所有读写通过 `WorkspaceFS`
+- 统一 LLM 抽象：`ConversationItem` / `ConversationState` / `UnifiedLLMRequest` / `UnifiedLLMResponse`
+- Provider 支持（同步、非流式、文本）
+  - OpenAI (`responses` / `chat_completions`)
+  - Anthropic (`messages`)
+  - Gemini (`generateContent`)
+  - Qwen（OpenAI-compatible `chat_completions`）
+  - vLLM（OpenAI-compatible `chat_completions`）
+- 工具系统：注册式工具机制，工具模块放在 `src/agentkit/tools/library/`
+- Agent loop：模型推理与工具执行闭环，受 step/time budget 约束
+- runlog：每次任务写入 `workspace/logs/run_<run_id>.jsonl`
+
+## 状态
+
+- 当前仓库包含针对 Agent loop、CLI、工具系统、runlog 以及 OpenAI / Anthropic / Gemini / Qwen / vLLM provider 适配层的单元测试
+- 尚未提供针对真实上游 API 的集成 smoke test，因此正式发布前仍建议用目标模型做一次端到端验证
+
+## 文档
+
+详细使用说明和完整文档见 `docs/agentkit/`。
+
+## 从源码安装
+
+```bash
+uv sync
+uv run agentkit --help
+```
+
+## 从 PyPI 安装
+
+```bash
+pip install base-agentkit
+agentkit --help
+```
+
+安装后的导入路径和 CLI 名称保持不变：
+
+```python
+from agentkit import create_agent
+```
+
+## 配置示例
+
+### vLLM
+
+```yaml
+workspace:
+  root: "./vllm_workspace"
+
+provider:
+  kind: "vllm"
+  model: "glm-5"
+  openai_api_variant: "chat_completions"
+  conversation_mode: "auto"
+  base_url: "http://localhost:8000/v1"
+  api_key: "empty"
+  temperature: 0.8
+  timeout_s: 600
+  retries: 2
+  enable_thinking: true
+
+agent:
+  system_prompt: "You are a helpful agent. Use tools when needed."
+  budget:
+    max_steps: 200
+    time_budget_s: 1800
+    max_input_chars: 180000
+
+tools:
+  allowed:
+    - "view"
+    - "create_file"
+    - "str_replace"
+    - "word_count"
+
+runlog:
+  enabled: true
+  redact: true
+  max_text_chars: 20000
+```
+
+## CLI 运行
+
+```bash
+export OPENAI_API_KEY="your-key"
+uv run agentkit --config path/to/config.yaml run --task "列出当前 workspace 的文件"
+```
+
+## Python SDK
+
+```python
+from agentkit import create_agent
+
+agent = create_agent("path/to/config.yaml")
+report = agent.run("在 workspace 里新建 notes/todo.txt 并写入今天计划")
+print(report.final_output)
+```
+
+## 项目结构
+
+核心实现位于 `src/agentkit/`：
+
+- `config/`: 配置结构与加载
+- `workspace/`: 强隔离文件系统和目录布局
+- `llm/`: 统一抽象、provider base/factory 与四平台 adapter
+- `tools/`: 工具抽象、注册表与自动加载
+- `agent/`: budget、report、runtime、Agent loop
+- `runlog/`: 结构化事件、event sink 与 JSONL runlog
+- `cli/`: 命令行入口

base_agentkit-0.1.0/pyproject.toml

@@ -0,0 +1,54 @@
+[project]
+name = "base-agentkit"
+version = "0.1.0"
+description = "Workspace-isolated Python framework for building tool-using LLM agents."
+readme = "README.md"
+authors = [{ name = "sii-nyc", email = "253108120111@sii.edu.cn" }]
+requires-python = ">=3.12"
+license = "Apache-2.0"
+license-files = ["LICENSE"]
+keywords = ["agents", "llm", "tool-calling", "workspace", "ai"]
+classifiers = [
+    "Development Status :: 3 - Alpha",
+    "Intended Audience :: Developers",
+    "License :: OSI Approved :: Apache Software License",
+    "Programming Language :: Python :: 3",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Typing :: Typed",
+]
+dependencies = [
+    "openai>=2.21.0",
+    "pydantic>=2.12.5",
+    "pyyaml>=6.0.3",
+    "requests>=2.32.5",
+]
+
+[project.scripts]
+agentkit = "agentkit.cli.main:main"
+
+[project.urls]
+Homepage = "https://github.com/Inkjourney/agentkit"
+Repository = "https://github.com/Inkjourney/agentkit"
+Documentation = "https://github.com/Inkjourney/agentkit/tree/main/docs/agentkit"
+Issues = "https://github.com/Inkjourney/agentkit/issues"
+
+[dependency-groups]
+dev = [
+    "mkdocs>=1.6.1,<2",
+    "mkdocs-material>=9.7.1",
+    "mkdocstrings[python]>=1.0.3",
+    "pytest>=8.4.2",
+    "ruff>=0.15.5",
+]
+
+[build-system]
+requires = ["uv_build>=0.9.17,<0.10.0"]
+build-backend = "uv_build"
+
+[tool.uv.build-backend]
+module-name = "agentkit"
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]
+addopts = "-ra"

base_agentkit-0.1.0/src/agentkit/__init__.py

@@ -0,0 +1,35 @@
+"""Generic LLM agent framework."""
+
+from __future__ import annotations
+
+from pathlib import Path
+
+from .agent.agent import Agent
+from .config.loader import load_config
+from .config.schema import AgentkitConfig
+
+
+def create_agent(
+    config_or_path: AgentkitConfig | str | Path,
+) -> Agent:
+    """Build an :class:`Agent` from config data or a config file.
+
+    Args:
+        config_or_path: Either a fully instantiated framework config object or a
+            filesystem path to a YAML/JSON config file.
+
+    Returns:
+        Agent: A configured agent instance ready to execute tasks.
+
+    Raises:
+        agentkit.errors.ConfigError: If the config file is invalid or missing required
+            fields.
+    """
+    if isinstance(config_or_path, AgentkitConfig):
+        config = config_or_path
+    else:
+        config = load_config(config_or_path)
+    return Agent.from_config(config)
+
+
+__all__ = ["Agent", "AgentkitConfig", "create_agent", "load_config"]

base_agentkit-0.1.0/src/agentkit/agent/__init__.py

@@ -0,0 +1,7 @@
+"""Public agent runtime exports."""
+
+from .agent import Agent
+from .report import RunReport
+from .tool_runtime import AgentToolRuntime
+
+__all__ = ["Agent", "AgentToolRuntime", "RunReport"]