ima-python-sdk 0.1.0__tar.gz

ima_python_sdk-0.1.0/LICENSE

@@ -0,0 +1,21 @@
+MIT License
+
+Copyright (c) 2025 elxy
+
+Permission is hereby granted, free of charge, to any person obtaining a copy
+of this software and associated documentation files (the "Software"), to deal
+in the Software without restriction, including without limitation the rights
+to use, copy, modify, merge, publish, distribute, sublicense, and/or sell
+copies of the Software, and to permit persons to whom the Software is
+furnished to do so, subject to the following conditions:
+
+The above copyright notice and this permission notice shall be included in all
+copies or substantial portions of the Software.
+
+THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR
+IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY,
+FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE
+AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER
+LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM,
+OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE
+SOFTWARE.

ima_python_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: ima-python-sdk
+Version: 0.1.0
+Summary: 非官方的 IMA OpenAPI Python SDK，提供知识库和笔记管理功能
+Author: elxy
+License: MIT
+Project-URL: Homepage, https://github.com/elxy/ima-python-sdk
+Project-URL: Repository, https://github.com/elxy/ima-python-sdk
+Project-URL: Issues, https://github.com/elxy/ima-python-sdk/issues
+Keywords: ima,knowledge-base,notes,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# ima-python-sdk
+
+非官方的 IMA OpenAPI Python SDK，提供知识库和笔记管理功能。
+
+> 本项目参考 [ima-skills](https://clawhub.ai/iampennyli/ima-skills) 中的 API 文档和脚本实现，与 IMA 官方无关。
+
+## 安装
+
+```bash
+pip install ima-python-sdk
+```
+
+## 配置
+
+SDK 需要 `client_id` 和 `api_key` 两个凭证，按以下优先级自动发现：
+
+1. **构造参数** — `ImaClient(client_id="...", api_key="...")`
+2. **环境变量** — `IMA_OPENAPI_CLIENTID` / `IMA_OPENAPI_APIKEY`
+3. **配置文件** — `~/.config/ima/client_id` / `~/.config/ima/api_key`
+
+## CLI 使用
+
+`--kb_id` 可通过环境变量 `IMA_KB_ID` 设置，避免每次手动指定。
+
+```bash
+# 知识库
+ima-sdk kb addable
+ima-sdk kb upload report.pdf --kb_id xxx                   # 上传到根目录
+ima-sdk kb upload report.pdf 论文/机器学习 --kb_id xxx      # 上传到指定目录
+ima-sdk kb import-url https://example.com --kb_id xxx
+
+# 笔记
+ima-sdk note search "会议记录"
+ima-sdk note create "# 标题"
+ima-sdk note read <doc_id> --raw
+```
+
+## SDK 使用
+
+```python
+from ima_sdk import ImaClient, KnowledgeBaseManager, NotesManager
+
+client = ImaClient()  # 自动读取环境变量或配置文件
+kb = KnowledgeBaseManager(client)
+notes = NotesManager(client)
+
+# 知识库操作
+kb.upload_file("/path/to/report.pdf", knowledge_base_id="xxx")
+kb.import_urls(["https://example.com"], knowledge_base_id="xxx")
+results = kb.search_knowledge("关键词", knowledge_base_id="xxx")
+
+# 笔记操作
+doc_id = notes.create("# 标题\n\n正文内容")
+docs, total, is_end = notes.search("会议记录")
+content = notes.get_content(doc_id)
+```
+
+## 特性
+
+- **零第三方依赖** — 仅使用 Python 标准库（urllib, hmac, hashlib, dataclasses）
+- **凭证自动发现** — 构造参数 > 环境变量 > 配置文件，三级优先
+- **自动翻页** — 列表接口支持 `fetch_all=True`
+- **完整上传流程** — `upload_file()` 一个方法完成预检、重名检查、创建媒体、COS 上传、添加知识
+- **UTF-8 安全** — 笔记写入前自动校验编码
+
+## License
+
+MIT

ima_python_sdk-0.1.0/README.md

@@ -0,0 +1,68 @@
+# ima-python-sdk
+
+非官方的 IMA OpenAPI Python SDK，提供知识库和笔记管理功能。
+
+> 本项目参考 [ima-skills](https://clawhub.ai/iampennyli/ima-skills) 中的 API 文档和脚本实现，与 IMA 官方无关。
+
+## 安装
+
+```bash
+pip install ima-python-sdk
+```
+
+## 配置
+
+SDK 需要 `client_id` 和 `api_key` 两个凭证，按以下优先级自动发现：
+
+1. **构造参数** — `ImaClient(client_id="...", api_key="...")`
+2. **环境变量** — `IMA_OPENAPI_CLIENTID` / `IMA_OPENAPI_APIKEY`
+3. **配置文件** — `~/.config/ima/client_id` / `~/.config/ima/api_key`
+
+## CLI 使用
+
+`--kb_id` 可通过环境变量 `IMA_KB_ID` 设置，避免每次手动指定。
+
+```bash
+# 知识库
+ima-sdk kb addable
+ima-sdk kb upload report.pdf --kb_id xxx                   # 上传到根目录
+ima-sdk kb upload report.pdf 论文/机器学习 --kb_id xxx      # 上传到指定目录
+ima-sdk kb import-url https://example.com --kb_id xxx
+
+# 笔记
+ima-sdk note search "会议记录"
+ima-sdk note create "# 标题"
+ima-sdk note read <doc_id> --raw
+```
+
+## SDK 使用
+
+```python
+from ima_sdk import ImaClient, KnowledgeBaseManager, NotesManager
+
+client = ImaClient()  # 自动读取环境变量或配置文件
+kb = KnowledgeBaseManager(client)
+notes = NotesManager(client)
+
+# 知识库操作
+kb.upload_file("/path/to/report.pdf", knowledge_base_id="xxx")
+kb.import_urls(["https://example.com"], knowledge_base_id="xxx")
+results = kb.search_knowledge("关键词", knowledge_base_id="xxx")
+
+# 笔记操作
+doc_id = notes.create("# 标题\n\n正文内容")
+docs, total, is_end = notes.search("会议记录")
+content = notes.get_content(doc_id)
+```
+
+## 特性
+
+- **零第三方依赖** — 仅使用 Python 标准库（urllib, hmac, hashlib, dataclasses）
+- **凭证自动发现** — 构造参数 > 环境变量 > 配置文件，三级优先
+- **自动翻页** — 列表接口支持 `fetch_all=True`
+- **完整上传流程** — `upload_file()` 一个方法完成预检、重名检查、创建媒体、COS 上传、添加知识
+- **UTF-8 安全** — 笔记写入前自动校验编码
+
+## License
+
+MIT

ima_python_sdk-0.1.0/ima_python_sdk.egg-info/PKG-INFO

@@ -0,0 +1,93 @@
+Metadata-Version: 2.4
+Name: ima-python-sdk
+Version: 0.1.0
+Summary: 非官方的 IMA OpenAPI Python SDK，提供知识库和笔记管理功能
+Author: elxy
+License: MIT
+Project-URL: Homepage, https://github.com/elxy/ima-python-sdk
+Project-URL: Repository, https://github.com/elxy/ima-python-sdk
+Project-URL: Issues, https://github.com/elxy/ima-python-sdk/issues
+Keywords: ima,knowledge-base,notes,sdk
+Classifier: Development Status :: 3 - Alpha
+Classifier: License :: OSI Approved :: MIT License
+Classifier: Programming Language :: Python :: 3
+Classifier: Programming Language :: Python :: 3.8
+Classifier: Programming Language :: Python :: 3.9
+Classifier: Programming Language :: Python :: 3.10
+Classifier: Programming Language :: Python :: 3.11
+Classifier: Programming Language :: Python :: 3.12
+Classifier: Programming Language :: Python :: 3.13
+Classifier: Operating System :: OS Independent
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+License-File: LICENSE
+Dynamic: license-file
+
+# ima-python-sdk
+
+非官方的 IMA OpenAPI Python SDK，提供知识库和笔记管理功能。
+
+> 本项目参考 [ima-skills](https://clawhub.ai/iampennyli/ima-skills) 中的 API 文档和脚本实现，与 IMA 官方无关。
+
+## 安装
+
+```bash
+pip install ima-python-sdk
+```
+
+## 配置
+
+SDK 需要 `client_id` 和 `api_key` 两个凭证，按以下优先级自动发现：
+
+1. **构造参数** — `ImaClient(client_id="...", api_key="...")`
+2. **环境变量** — `IMA_OPENAPI_CLIENTID` / `IMA_OPENAPI_APIKEY`
+3. **配置文件** — `~/.config/ima/client_id` / `~/.config/ima/api_key`
+
+## CLI 使用
+
+`--kb_id` 可通过环境变量 `IMA_KB_ID` 设置，避免每次手动指定。
+
+```bash
+# 知识库
+ima-sdk kb addable
+ima-sdk kb upload report.pdf --kb_id xxx                   # 上传到根目录
+ima-sdk kb upload report.pdf 论文/机器学习 --kb_id xxx      # 上传到指定目录
+ima-sdk kb import-url https://example.com --kb_id xxx
+
+# 笔记
+ima-sdk note search "会议记录"
+ima-sdk note create "# 标题"
+ima-sdk note read <doc_id> --raw
+```
+
+## SDK 使用
+
+```python
+from ima_sdk import ImaClient, KnowledgeBaseManager, NotesManager
+
+client = ImaClient()  # 自动读取环境变量或配置文件
+kb = KnowledgeBaseManager(client)
+notes = NotesManager(client)
+
+# 知识库操作
+kb.upload_file("/path/to/report.pdf", knowledge_base_id="xxx")
+kb.import_urls(["https://example.com"], knowledge_base_id="xxx")
+results = kb.search_knowledge("关键词", knowledge_base_id="xxx")
+
+# 笔记操作
+doc_id = notes.create("# 标题\n\n正文内容")
+docs, total, is_end = notes.search("会议记录")
+content = notes.get_content(doc_id)
+```
+
+## 特性
+
+- **零第三方依赖** — 仅使用 Python 标准库（urllib, hmac, hashlib, dataclasses）
+- **凭证自动发现** — 构造参数 > 环境变量 > 配置文件，三级优先
+- **自动翻页** — 列表接口支持 `fetch_all=True`
+- **完整上传流程** — `upload_file()` 一个方法完成预检、重名检查、创建媒体、COS 上传、添加知识
+- **UTF-8 安全** — 笔记写入前自动校验编码
+
+## License
+
+MIT

ima_python_sdk-0.1.0/ima_python_sdk.egg-info/SOURCES.txt

@@ -0,0 +1,17 @@
+LICENSE
+README.md
+pyproject.toml
+ima_python_sdk.egg-info/PKG-INFO
+ima_python_sdk.egg-info/SOURCES.txt
+ima_python_sdk.egg-info/dependency_links.txt
+ima_python_sdk.egg-info/entry_points.txt
+ima_python_sdk.egg-info/top_level.txt
+ima_sdk/__init__.py
+ima_sdk/cli.py
+ima_sdk/client.py
+ima_sdk/cos_uploader.py
+ima_sdk/file_checker.py
+ima_sdk/knowledge_base.py
+ima_sdk/logger.py
+ima_sdk/notes.py
+ima_sdk/types.py

ima_python_sdk-0.1.0/ima_python_sdk.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

ima_python_sdk-0.1.0/ima_python_sdk.egg-info/entry_points.txt

@@ -0,0 +1,2 @@
+[console_scripts]
+ima-sdk = ima_sdk.cli:main

ima_python_sdk-0.1.0/ima_python_sdk.egg-info/top_level.txt

@@ -0,0 +1 @@
+ima_sdk

ima_python_sdk-0.1.0/ima_sdk/__init__.py

@@ -0,0 +1,90 @@
+"""IMA Python SDK — 知识库和笔记操作。
+
+用法::
+
+    from ima_sdk import ImaClient, KnowledgeBaseManager, NotesManager
+
+    client = ImaClient()
+    kb = KnowledgeBaseManager(client)
+    notes = NotesManager(client)
+
+    # 搜索知识库
+    results = kb.search_knowledge_base("我的资料")
+
+    # 上传文件到知识库
+    kb.upload_file("/path/to/report.pdf", knowledge_base_id="xxx")
+
+    # 创建笔记
+    doc_id = notes.create("# 标题\\n\\n正文内容")
+
+    # 搜索笔记
+    docs, total, is_end = notes.search("会议记录")
+"""
+
+__version__ = "0.1.0"
+
+from .client import ImaApiError, ImaClient
+from .cos_uploader import cos_upload
+from .file_checker import check_file
+from .knowledge_base import KnowledgeBaseManager
+from .notes import NotesManager
+from .types import (
+    AddableKnowledgeBaseInfo,
+    CheckRepeatedNameResult,
+    ContentFormat,
+    CosCredential,
+    CreateMediaResult,
+    DocBasic,
+    FileCheckResult,
+    FileInfo,
+    FolderType,
+    ImportURLResult,
+    KBFolderInfo,
+    KnowledgeBaseInfo,
+    KnowledgeInfo,
+    KnowledgeListResult,
+    MediaType,
+    NoteBookInfo,
+    NoteFolderItem,
+    SearchedDoc,
+    SearchedKnowledgeBaseInfo,
+    SearchedKnowledgeInfo,
+    SearchType,
+    SortType,
+)
+
+__all__ = [
+    # 核心
+    "ImaClient",
+    "ImaApiError",
+    # 管理器
+    "KnowledgeBaseManager",
+    "NotesManager",
+    # 工具函数
+    "check_file",
+    "cos_upload",
+    # 类型
+    "KnowledgeBaseInfo",
+    "KnowledgeInfo",
+    "KBFolderInfo",
+    "AddableKnowledgeBaseInfo",
+    "SearchedKnowledgeBaseInfo",
+    "SearchedKnowledgeInfo",
+    "ImportURLResult",
+    "CosCredential",
+    "FileInfo",
+    "CreateMediaResult",
+    "CheckRepeatedNameResult",
+    "KnowledgeListResult",
+    "FileCheckResult",
+    "DocBasic",
+    "NoteFolderItem",
+    "NoteBookInfo",
+    "SearchedDoc",
+    # 枚举
+    "MediaType",
+    "ContentFormat",
+    "SearchType",
+    "SortType",
+    "FolderType",
+]