tianjian-api 0.1.0__tar.gz

tianjian_api-0.1.0/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: tianjian-api
+Version: 0.1.0
+Summary: Python SDK for Tianjian API platform
+Author: Tianjian API
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.28
+
+# Tianjian API Python SDK
+
+简洁同步版 SDK，适合服务端脚本、业务系统和定时任务接入。它是独立 Python 第三方库，不改变网站现有业务接口。
+
+## 安装
+
+```bash
+pip install -e .
+```
+
+## 快速开始
+
+```python
+from tianjian_api import TianjianClient
+
+client = TianjianClient(
+    api_key="你的 API KEY",
+    base_url="https://ocr.ikunocr.cn",
+    type="api",
+    proxy="http://127.0.0.1:7890",  # SDK 请求平台时使用的网络代理，可不填
+    timeout=10,
+)
+
+res = client.call("16hangzhoudxdx", c="xxx", api_proxy="http://user:pass@ip:port/")
+print(res)
+```
+
+## 常用能力
+
+- `client.call(path, **params)` 调用任意产品接口，自动携带 `key`。
+- `client.get(path, **params)` 使用 GET 调用产品接口。
+- `client.post(path, **params)` 使用 POST 调用产品接口。
+- `client.balance()` 查询余额，需要平台提供 API KEY 查询接口后配置 `balance_path`。
+- `client.packages()` 查询当前用户套餐，需要平台提供 API KEY 查询接口后配置 `packages_path`。
+
+注意：`proxy` 是 SDK 自己访问平台时使用的网络代理；`api_proxy` 是传给平台产品接口的业务代理参数，未传时不会发送该字段。
+
+## 查询余额和套餐
+
+如果后续平台开放查询接口，例如：
+
+```text
+GET /api/account/balance/get?key=你的密钥
+GET /api/account/packages/get?key=你的密钥
+```
+
+SDK 可以这样接入：
+
+```python
+client = TianjianClient(
+    api_key="你的 API KEY",
+    base_url="https://ocr.ikunocr.cn",
+    balance_path="account/balance",
+    packages_path="account/packages",
+)
+
+print(client.balance())
+print(client.packages())
+```
+
+这样第三方库保持独立，网站什么时候开放查询能力，SDK 就什么时候启用。

tianjian_api-0.1.0/README.md

@@ -0,0 +1,61 @@
+# Tianjian API Python SDK
+
+简洁同步版 SDK，适合服务端脚本、业务系统和定时任务接入。它是独立 Python 第三方库，不改变网站现有业务接口。
+
+## 安装
+
+```bash
+pip install -e .
+```
+
+## 快速开始
+
+```python
+from tianjian_api import TianjianClient
+
+client = TianjianClient(
+    api_key="你的 API KEY",
+    base_url="https://ocr.ikunocr.cn",
+    type="api",
+    proxy="http://127.0.0.1:7890",  # SDK 请求平台时使用的网络代理，可不填
+    timeout=10,
+)
+
+res = client.call("16hangzhoudxdx", c="xxx", api_proxy="http://user:pass@ip:port/")
+print(res)
+```
+
+## 常用能力
+
+- `client.call(path, **params)` 调用任意产品接口，自动携带 `key`。
+- `client.get(path, **params)` 使用 GET 调用产品接口。
+- `client.post(path, **params)` 使用 POST 调用产品接口。
+- `client.balance()` 查询余额，需要平台提供 API KEY 查询接口后配置 `balance_path`。
+- `client.packages()` 查询当前用户套餐，需要平台提供 API KEY 查询接口后配置 `packages_path`。
+
+注意：`proxy` 是 SDK 自己访问平台时使用的网络代理；`api_proxy` 是传给平台产品接口的业务代理参数，未传时不会发送该字段。
+
+## 查询余额和套餐
+
+如果后续平台开放查询接口，例如：
+
+```text
+GET /api/account/balance/get?key=你的密钥
+GET /api/account/packages/get?key=你的密钥
+```
+
+SDK 可以这样接入：
+
+```python
+client = TianjianClient(
+    api_key="你的 API KEY",
+    base_url="https://ocr.ikunocr.cn",
+    balance_path="account/balance",
+    packages_path="account/packages",
+)
+
+print(client.balance())
+print(client.packages())
+```
+
+这样第三方库保持独立，网站什么时候开放查询能力，SDK 就什么时候启用。

tianjian_api-0.1.0/pyproject.toml

@@ -0,0 +1,15 @@
+[build-system]
+requires = ["setuptools>=68"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "tianjian-api"
+version = "0.1.0"
+description = "Python SDK for Tianjian API platform"
+readme = "README.md"
+requires-python = ">=3.8"
+dependencies = ["requests>=2.28"]
+authors = [{ name = "Tianjian API" }]
+
+[tool.setuptools.packages.find]
+where = ["src"]

tianjian_api-0.1.0/setup.cfg

@@ -0,0 +1,4 @@
+[egg_info]
+tag_build = 
+tag_date = 0
+

tianjian_api-0.1.0/src/tianjian_api/__init__.py

@@ -0,0 +1,17 @@
+from .client import TianjianClient
+from .exceptions import (
+    TianjianAPIError,
+    TianjianAuthError,
+    TianjianHTTPError,
+    TianjianNotConfiguredError,
+    TianjianResponseError,
+)
+
+__all__ = [
+    "TianjianClient",
+    "TianjianAPIError",
+    "TianjianAuthError",
+    "TianjianHTTPError",
+    "TianjianNotConfiguredError",
+    "TianjianResponseError",
+]

tianjian_api-0.1.0/src/tianjian_api/client.py

@@ -0,0 +1,109 @@
+from __future__ import annotations
+
+from typing import Any, Dict, Optional
+from urllib.parse import urljoin
+
+import requests
+
+from .exceptions import (
+    TianjianAuthError,
+    TianjianHTTPError,
+    TianjianNotConfiguredError,
+    TianjianResponseError,
+)
+
+
+class TianjianClient:
+    def __init__(
+        self,
+        api_key: str,
+        base_url: str = "https://ocr.ikunocr.cn",
+        type: str = "api",
+        proxy: Optional[str] = None,
+        timeout: float = 10,
+        balance_path: Optional[str] = None,
+        packages_path: Optional[str] = None,
+        account_path: Optional[str] = None,
+        session: Optional[requests.Session] = None,
+    ) -> None:
+        if not api_key:
+            raise ValueError("api_key is required")
+        self.api_key = api_key
+        self.base_url = base_url.rstrip("/") + "/"
+        self.type = type
+        self.timeout = timeout
+        self.balance_path = balance_path
+        self.packages_path = packages_path
+        self.account_path = account_path
+        self.session = session or requests.Session()
+        self.proxies = {"http": proxy, "https": proxy} if proxy else None
+
+    def account(self) -> Dict[str, Any]:
+        if not self.account_path:
+            raise TianjianNotConfiguredError("account_path is not configured")
+        return self.get(self.account_path)
+
+    def balance(self) -> Any:
+        if not self.balance_path:
+            raise TianjianNotConfiguredError("balance_path is not configured")
+        return self.get(self.balance_path)
+
+    def packages(self) -> Any:
+        if not self.packages_path:
+            raise TianjianNotConfiguredError("packages_path is not configured")
+        return self.get(self.packages_path)
+
+    def call(self, path: str, method: str = "GET", api_proxy: Optional[str] = None, **params: Any) -> Any:
+        clean_params = {key: value for key, value in params.items() if value is not None and value != ""}
+        if api_proxy:
+            clean_params["proxy"] = api_proxy
+        return self.request(path, method=method, params=clean_params)
+
+    def get(self, path: str, **params: Any) -> Any:
+        return self.call(path, method="GET", **params)
+
+    def post(self, path: str, **params: Any) -> Any:
+        return self.call(path, method="POST", **params)
+
+    def request(self, path: str, method: str = "GET", params: Optional[Dict[str, Any]] = None) -> Any:
+        method = method.upper()
+        payload = dict(params or {})
+        payload["key"] = self.api_key
+        url = self._url(path)
+
+        if method == "GET":
+            response = self.session.get(url, params=payload, timeout=self.timeout, proxies=self.proxies)
+        elif method == "POST":
+            response = self.session.post(url, data=payload, timeout=self.timeout, proxies=self.proxies)
+        else:
+            raise ValueError("method must be GET or POST")
+
+        return self._parse_response(response)
+
+    def _url(self, path: str) -> str:
+        if path.startswith("http://") or path.startswith("https://"):
+            return path
+        normalized = path.lstrip("/")
+        if normalized.startswith("api/") and not normalized.endswith("/get"):
+            return urljoin(self.base_url, normalized)
+        if normalized.startswith("api/"):
+            return urljoin(self.base_url, normalized)
+        return urljoin(self.base_url, f"api/{normalized}/get")
+
+    def _parse_response(self, response: requests.Response) -> Any:
+        if response.status_code < 200 or response.status_code >= 300:
+            raise TianjianHTTPError(f"HTTP {response.status_code}: {response.text[:200]}")
+
+        try:
+            data = response.json()
+        except ValueError:
+            return response.text
+
+        code = data.get("code")
+        if code in (200, 0, "200", "0", None):
+            return data
+
+        message = data.get("msg") or data.get("message") or "request failed"
+        if str(code) in {"401", "403"}:
+            raise TianjianAuthError(message)
+        raise TianjianResponseError(message)

tianjian_api-0.1.0/src/tianjian_api/exceptions.py

@@ -0,0 +1,18 @@
+class TianjianAPIError(Exception):
+    """Base exception for Tianjian SDK errors."""
+
+
+class TianjianHTTPError(TianjianAPIError):
+    """Raised when the platform returns a non-2xx HTTP response."""
+
+
+class TianjianResponseError(TianjianAPIError):
+    """Raised when the platform returns a business error code."""
+
+
+class TianjianAuthError(TianjianResponseError):
+    """Raised when the API key is invalid or unauthorized."""
+
+
+class TianjianNotConfiguredError(TianjianAPIError):
+    """Raised when an optional SDK endpoint is not configured."""

tianjian_api-0.1.0/src/tianjian_api.egg-info/PKG-INFO

@@ -0,0 +1,70 @@
+Metadata-Version: 2.4
+Name: tianjian-api
+Version: 0.1.0
+Summary: Python SDK for Tianjian API platform
+Author: Tianjian API
+Requires-Python: >=3.8
+Description-Content-Type: text/markdown
+Requires-Dist: requests>=2.28
+
+# Tianjian API Python SDK
+
+简洁同步版 SDK，适合服务端脚本、业务系统和定时任务接入。它是独立 Python 第三方库，不改变网站现有业务接口。
+
+## 安装
+
+```bash
+pip install -e .
+```
+
+## 快速开始
+
+```python
+from tianjian_api import TianjianClient
+
+client = TianjianClient(
+    api_key="你的 API KEY",
+    base_url="https://ocr.ikunocr.cn",
+    type="api",
+    proxy="http://127.0.0.1:7890",  # SDK 请求平台时使用的网络代理，可不填
+    timeout=10,
+)
+
+res = client.call("16hangzhoudxdx", c="xxx", api_proxy="http://user:pass@ip:port/")
+print(res)
+```
+
+## 常用能力
+
+- `client.call(path, **params)` 调用任意产品接口，自动携带 `key`。
+- `client.get(path, **params)` 使用 GET 调用产品接口。
+- `client.post(path, **params)` 使用 POST 调用产品接口。
+- `client.balance()` 查询余额，需要平台提供 API KEY 查询接口后配置 `balance_path`。
+- `client.packages()` 查询当前用户套餐，需要平台提供 API KEY 查询接口后配置 `packages_path`。
+
+注意：`proxy` 是 SDK 自己访问平台时使用的网络代理；`api_proxy` 是传给平台产品接口的业务代理参数，未传时不会发送该字段。
+
+## 查询余额和套餐
+
+如果后续平台开放查询接口，例如：
+
+```text
+GET /api/account/balance/get?key=你的密钥
+GET /api/account/packages/get?key=你的密钥
+```
+
+SDK 可以这样接入：
+
+```python
+client = TianjianClient(
+    api_key="你的 API KEY",
+    base_url="https://ocr.ikunocr.cn",
+    balance_path="account/balance",
+    packages_path="account/packages",
+)
+
+print(client.balance())
+print(client.packages())
+```
+
+这样第三方库保持独立，网站什么时候开放查询能力，SDK 就什么时候启用。

tianjian_api-0.1.0/src/tianjian_api.egg-info/SOURCES.txt

@@ -0,0 +1,10 @@
+README.md
+pyproject.toml
+src/tianjian_api/__init__.py
+src/tianjian_api/client.py
+src/tianjian_api/exceptions.py
+src/tianjian_api.egg-info/PKG-INFO
+src/tianjian_api.egg-info/SOURCES.txt
+src/tianjian_api.egg-info/dependency_links.txt
+src/tianjian_api.egg-info/requires.txt
+src/tianjian_api.egg-info/top_level.txt

tianjian_api-0.1.0/src/tianjian_api.egg-info/dependency_links.txt

@@ -0,0 +1 @@
+

tianjian_api-0.1.0/src/tianjian_api.egg-info/requires.txt

@@ -0,0 +1 @@
+requests>=2.28

tianjian_api-0.1.0/src/tianjian_api.egg-info/top_level.txt

@@ -0,0 +1 @@
+tianjian_api