tinet-data-foundry-cli 0.1.1__tar.gz → 0.1.3__tar.gz

{tinet_data_foundry_cli-0.1.1 → tinet_data_foundry_cli-0.1.3}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tinet-data-foundry-cli
-Version: 0.1.1
+Version: 0.1.3
 Summary: Tinet Data Foundry 取数 CLI（catalog / query / schema）
 Author: Tinet
 License: MIT
@@ -19,7 +19,11 @@ Description-Content-Type: text/markdown
 
 Tinet Data Foundry 取数 CLI。包名 `tinet-data-foundry-cli`，命令 **`tdf`**（避开系统磁盘命令 `df`）。
 
-鉴权只用环境变量，**不要**把 AccessKey / SecretKey 写入本地文件。
+鉴权只用环境变量，**不要**把 AccessKey / SecretKey 写入本地文件。需要 Python **≥ 3.10**。
+
+macOS / Linux 用 Terminal（bash / zsh）。Windows 用 **cmd.exe** 跑下面示例（不要用 PowerShell 传 JSON：`export` 不可用，引号也会被剥掉）。
+
+## macOS / Linux
 
 ```bash
 pip install -U tinet-data-foundry-cli
@@ -39,7 +43,30 @@ tdf query \
   --page-size 10
 ```
 
-需要 Python **≥ 3.10**。若 pip 提示 scripts 目录不在 PATH，把该目录加入 PATH，或用 `python3 -m tinet_data_foundry_cli`。
+若 pip 提示 scripts 目录不在 PATH，把该目录加入 PATH，或用 `python3 -m tinet_data_foundry_cli`。
+
+## Windows（cmd.exe）
+
+```bat
+pip install -U tinet-data-foundry-cli
+
+set DF_ENDPOINT=https://data-foundry-data-api.tinetcloud.com
+set DF_AK=你的_AccessKey
+set DF_SK=你的_SecretKey
+
+tdf catalog
+tdf schema --dataset "DATASET_ID"
+tdf query --dataset "DATASET_ID" --fields "id" --filter "{\"op\":\"eq\",\"field\":\"id\",\"value\":\"sample\"}" --sort "[{\"field\":\"id\",\"direction\":\"DESC\"}]" --page-no 1 --page-size 10
+```
+
+环境变量只对当前 cmd 窗口有效。JSON 参数用 `\"` 转义，整条命令写在一行。
+
+公司代理 / 自签证书导致 `CERTIFICATE_VERIFY_FAILED` 时：
+
+```bash
+tdf --insecure catalog
+tdf catalog --insecure
+```
 
 | 命令 | 接口 |
 | --- | --- |

{tinet_data_foundry_cli-0.1.1 → tinet_data_foundry_cli-0.1.3}/README.md

@@ -2,7 +2,11 @@
 
 Tinet Data Foundry 取数 CLI。包名 `tinet-data-foundry-cli`，命令 **`tdf`**（避开系统磁盘命令 `df`）。
 
-鉴权只用环境变量，**不要**把 AccessKey / SecretKey 写入本地文件。
+鉴权只用环境变量，**不要**把 AccessKey / SecretKey 写入本地文件。需要 Python **≥ 3.10**。
+
+macOS / Linux 用 Terminal（bash / zsh）。Windows 用 **cmd.exe** 跑下面示例（不要用 PowerShell 传 JSON：`export` 不可用，引号也会被剥掉）。
+
+## macOS / Linux
 
 ```bash
 pip install -U tinet-data-foundry-cli
@@ -22,7 +26,30 @@ tdf query \
   --page-size 10
 ```
 
-需要 Python **≥ 3.10**。若 pip 提示 scripts 目录不在 PATH，把该目录加入 PATH，或用 `python3 -m tinet_data_foundry_cli`。
+若 pip 提示 scripts 目录不在 PATH，把该目录加入 PATH，或用 `python3 -m tinet_data_foundry_cli`。
+
+## Windows（cmd.exe）
+
+```bat
+pip install -U tinet-data-foundry-cli
+
+set DF_ENDPOINT=https://data-foundry-data-api.tinetcloud.com
+set DF_AK=你的_AccessKey
+set DF_SK=你的_SecretKey
+
+tdf catalog
+tdf schema --dataset "DATASET_ID"
+tdf query --dataset "DATASET_ID" --fields "id" --filter "{\"op\":\"eq\",\"field\":\"id\",\"value\":\"sample\"}" --sort "[{\"field\":\"id\",\"direction\":\"DESC\"}]" --page-no 1 --page-size 10
+```
+
+环境变量只对当前 cmd 窗口有效。JSON 参数用 `\"` 转义，整条命令写在一行。
+
+公司代理 / 自签证书导致 `CERTIFICATE_VERIFY_FAILED` 时：
+
+```bash
+tdf --insecure catalog
+tdf catalog --insecure
+```
 
 | 命令 | 接口 |
 | --- | --- |

{tinet_data_foundry_cli-0.1.1 → tinet_data_foundry_cli-0.1.3}/pyproject.toml

@@ -4,7 +4,7 @@ build-backend = "setuptools.build_meta"
 
 [project]
 name = "tinet-data-foundry-cli"
-version = "0.1.1"
+version = "0.1.3"
 description = "Tinet Data Foundry 取数 CLI（catalog / query / schema）"
 readme = "README.md"
 requires-python = ">=3.10"

tinet_data_foundry_cli-0.1.3/src/tinet_data_foundry_cli/__init__.py

@@ -0,0 +1 @@
+__version__ = "0.1.3"

{tinet_data_foundry_cli-0.1.1 → tinet_data_foundry_cli-0.1.3}/src/tinet_data_foundry_cli/cli.py

@@ -7,7 +7,7 @@ from typing import Any, List, Mapping, Optional
 
 from tinet_data_foundry_cli import __version__
 from tinet_data_foundry_cli.auth import credentials
-from tinet_data_foundry_cli.client import ApiError, request
+from tinet_data_foundry_cli.client import ApiError, TransportError, request
 
 
 def _parse_json(raw: Optional[str], flag: str) -> Any:
@@ -52,6 +52,16 @@ def _print_catalog_table(rows: List[Mapping[str, Any]]) -> None:
         print("  ".join(_cell(row.get(key), w) for key, _, w in cols))
 
 
+def _exit_transport(err: TransportError) -> None:
+    raise SystemExit(
+        "无法连接取数网关："
+        f"{err}\n"
+        "若错误含 CERTIFICATE_VERIFY_FAILED / self-signed certificate，多半是公司代理或自签证书。"
+        "请加 --insecure（写在子命令前或后均可），例如：\n"
+        "  tdf --insecure catalog"
+    ) from err
+
+
 def _exit_api(err: ApiError) -> None:
     payload = err.payload if isinstance(err.payload, dict) else {"message": str(err.payload)}
     _print_json(payload)
@@ -93,6 +103,8 @@ def cmd_catalog(args: argparse.Namespace) -> int:
         )
     except ApiError as ex:
         _exit_api(ex)
+    except TransportError as ex:
+        _exit_transport(ex)
     if args.dry_run or args.format == "json":
         _print_json(parsed)
         return 0
@@ -135,6 +147,8 @@ def cmd_query(args: argparse.Namespace) -> int:
         )
     except ApiError as ex:
         _exit_api(ex)
+    except TransportError as ex:
+        _exit_transport(ex)
     _print_json(parsed)
     if isinstance(parsed, dict) and parsed.get("code") not in (None, 0, "0") and not args.dry_run:
         return 1
@@ -157,12 +171,24 @@ def cmd_schema(args: argparse.Namespace) -> int:
         )
     except ApiError as ex:
         _exit_api(ex)
+    except TransportError as ex:
+        _exit_transport(ex)
     _print_json(parsed)
     if isinstance(parsed, dict) and parsed.get("code") not in (None, 0, "0") and not args.dry_run:
         return 1
     return 0
 
 
+def _add_insecure(parser: argparse.ArgumentParser, *, overlay: bool = False) -> None:
+    kwargs: dict[str, Any] = {
+        "action": "store_true",
+        "help": "跳过 TLS 校验（公司代理 / 自签证书，仅联调）",
+    }
+    if overlay:
+        kwargs["default"] = argparse.SUPPRESS
+    parser.add_argument("-k", "--insecure", **kwargs)
+
+
 def build_parser() -> argparse.ArgumentParser:
     p = argparse.ArgumentParser(
         prog="tdf",
@@ -171,11 +197,12 @@ def build_parser() -> argparse.ArgumentParser:
     p.add_argument("--version", action="version", version=f"tinet-data-foundry-cli {__version__}")
     p.add_argument("--endpoint", help="覆盖 DF_ENDPOINT")
     p.add_argument("--timeout", type=float, default=30)
-    p.add_argument("--insecure", action="store_true", help="跳过 TLS 校验（仅联调）")
+    _add_insecure(p)
     p.add_argument("--dry-run", action="store_true", help="只打印将发送的请求，不访问网关")
     sub = p.add_subparsers(dest="cmd", required=True)
 
     c = sub.add_parser("catalog", help="列出当前凭证有权访问的数据目录")
+    _add_insecure(c, overlay=True)
     c.add_argument("--keyword")
     c.add_argument("--layer", choices=["ods", "dwd"])
     c.add_argument("--domain", help="业务域 ID 或名称")
@@ -183,6 +210,7 @@ def build_parser() -> argparse.ArgumentParser:
     c.set_defaults(func=cmd_catalog)
 
     q = sub.add_parser("query", help="查询 Dataset")
+    _add_insecure(q, overlay=True)
     q.add_argument("--dataset", required=True)
     q.add_argument("--fields", help="逗号分隔列名")
     q.add_argument("--filter", help="filter AST JSON")
@@ -193,6 +221,7 @@ def build_parser() -> argparse.ArgumentParser:
     q.set_defaults(func=cmd_query)
 
     s = sub.add_parser("schema", help="拉取 Dataset Schema")
+    _add_insecure(s, overlay=True)
     s.add_argument("--dataset", required=True)
     s.set_defaults(func=cmd_schema)
     return p

{tinet_data_foundry_cli-0.1.1 → tinet_data_foundry_cli-0.1.3}/src/tinet_data_foundry_cli/client.py

@@ -17,6 +17,10 @@ class ApiError(Exception):
         super().__init__(f"HTTP {http_status}: {payload}")
 
 
+class TransportError(Exception):
+    """网络或 TLS 失败（含公司代理自签证书）。"""
+
+
 def request(
     method: str,
     endpoint: str,
@@ -65,3 +69,5 @@ def request(
         except json.JSONDecodeError:
             parsed = {"message": raw.decode("utf-8", errors="replace")}
         raise ApiError(ex.code, parsed) from ex
+    except (urllib.error.URLError, ssl.SSLError, TimeoutError, OSError) as ex:
+        raise TransportError(str(ex)) from ex

{tinet_data_foundry_cli-0.1.1 → tinet_data_foundry_cli-0.1.3}/src/tinet_data_foundry_cli.egg-info/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: tinet-data-foundry-cli
-Version: 0.1.1
+Version: 0.1.3
 Summary: Tinet Data Foundry 取数 CLI（catalog / query / schema）
 Author: Tinet
 License: MIT
@@ -19,7 +19,11 @@ Description-Content-Type: text/markdown
 
 Tinet Data Foundry 取数 CLI。包名 `tinet-data-foundry-cli`，命令 **`tdf`**（避开系统磁盘命令 `df`）。
 
-鉴权只用环境变量，**不要**把 AccessKey / SecretKey 写入本地文件。
+鉴权只用环境变量，**不要**把 AccessKey / SecretKey 写入本地文件。需要 Python **≥ 3.10**。
+
+macOS / Linux 用 Terminal（bash / zsh）。Windows 用 **cmd.exe** 跑下面示例（不要用 PowerShell 传 JSON：`export` 不可用，引号也会被剥掉）。
+
+## macOS / Linux
 
 ```bash
 pip install -U tinet-data-foundry-cli
@@ -39,7 +43,30 @@ tdf query \
   --page-size 10
 ```
 
-需要 Python **≥ 3.10**。若 pip 提示 scripts 目录不在 PATH，把该目录加入 PATH，或用 `python3 -m tinet_data_foundry_cli`。
+若 pip 提示 scripts 目录不在 PATH，把该目录加入 PATH，或用 `python3 -m tinet_data_foundry_cli`。
+
+## Windows（cmd.exe）
+
+```bat
+pip install -U tinet-data-foundry-cli
+
+set DF_ENDPOINT=https://data-foundry-data-api.tinetcloud.com
+set DF_AK=你的_AccessKey
+set DF_SK=你的_SecretKey
+
+tdf catalog
+tdf schema --dataset "DATASET_ID"
+tdf query --dataset "DATASET_ID" --fields "id" --filter "{\"op\":\"eq\",\"field\":\"id\",\"value\":\"sample\"}" --sort "[{\"field\":\"id\",\"direction\":\"DESC\"}]" --page-no 1 --page-size 10
+```
+
+环境变量只对当前 cmd 窗口有效。JSON 参数用 `\"` 转义，整条命令写在一行。
+
+公司代理 / 自签证书导致 `CERTIFICATE_VERIFY_FAILED` 时：
+
+```bash
+tdf --insecure catalog
+tdf catalog --insecure
+```
 
 | 命令 | 接口 |
 | --- | --- |

{tinet_data_foundry_cli-0.1.1 → tinet_data_foundry_cli-0.1.3}/tests/test_cli.py

@@ -11,8 +11,10 @@ class CliParserTest(unittest.TestCase):
         self.assertEqual(catalog.cmd, "catalog")
         query = parser.parse_args(["query", "--dataset", "ds_1", "--page-no", "1", "--page-size", "10"])
         self.assertEqual(query.cmd, "query")
-        schema = parser.parse_args(["schema", "--dataset", "ds_1"])
-        self.assertEqual(schema.cmd, "schema")
+        catalog_k = parser.parse_args(["catalog", "--insecure"])
+        self.assertTrue(catalog_k.insecure)
+        catalog_before = parser.parse_args(["--insecure", "catalog"])
+        self.assertTrue(catalog_before.insecure)
 
     def test_dry_run_catalog_does_not_need_network(self):
         with patch.dict("os.environ", {"DF_AK": "ak", "DF_SK": "sk" * 8}, clear=False):

tinet_data_foundry_cli-0.1.1/src/tinet_data_foundry_cli/__init__.py

@@ -1 +0,0 @@
-__version__ = "0.1.1"