fraclab-sdk 0.1.0__py3-none-any.whl → 0.1.1__py3-none-any.whl

fraclab_sdk/workbench/ui_styles.py

@@ -0,0 +1,91 @@
+"""Shared UI styling utility for Streamlit pages."""
+
+import streamlit as st
+
+
+def apply_global_styles():
+    """Inject global CSS to hide Streamlit UI elements and apply common styling."""
+    st.markdown("""
+    <style>
+        /* =================================
+           1. Hide Streamlit UI Elements
+           ================================= */
+
+        /* Hide top header bar */
+        header[data-testid="stHeader"] {
+            display: none !important;
+        }
+
+        /* Hide hamburger menu and Deploy button */
+        [data-testid="stToolbar"], .stDeployButton {
+            display: none !important;
+        }
+
+        /* Hide footer (Made with Streamlit) */
+        footer {
+            display: none !important;
+        }
+
+        /* Hide element toolbar on tables/dataframes */
+        [data-testid="stElementToolbar"] {
+            display: none !important;
+        }
+
+        /* Adjust main content padding (header hidden, content needs padding) */
+        .main .block-container {
+            padding-top: 2rem !important;
+            padding-bottom: 2rem !important;
+        }
+
+        /* =================================
+           2. Button Styling
+           ================================= */
+
+        div[data-testid="stButton"] button {
+            white-space: nowrap !important;
+            border-radius: 6px !important;
+            min-width: 60px !important;
+            font-weight: 500 !important;
+        }
+
+        /* =================================
+           3. Anti-Copy Protection
+           ================================= */
+
+        /* Disable text selection on key areas */
+        .element-container,
+        [data-testid="stDataFrame"],
+        [data-testid="stDataEditor"],
+        [data-testid="stCode"],
+        [data-testid="stJson"] {
+            user-select: none;
+            -webkit-user-select: none;
+            -moz-user-select: none;
+            -ms-user-select: none;
+        }
+
+        /* Hide copy buttons on st.code / st.json */
+        [data-testid="stCode"] button,
+        [data-testid="stJson"] button {
+            display: none !important;
+        }
+
+        /* =================================
+           4. Component Styling
+           ================================= */
+
+        /* Expander header styling */
+        .streamlit-expanderHeader {
+            font-weight: 600;
+            background-color: #f9f9fb;
+            border-radius: 6px;
+        }
+
+        /* Data Editor border styling */
+        [data-testid="stDataEditor"] {
+            border: 1px solid #e6e9ef;
+            border-radius: 6px;
+        }
+
+    </style>
+    """, unsafe_allow_html=True)

fraclab_sdk/workbench/utils.py

@@ -0,0 +1,43 @@
+"""Shared helpers for the Streamlit workbench."""
+
+from __future__ import annotations
+
+import os
+import subprocess
+import sys
+from pathlib import Path
+
+from fraclab_sdk.config import SDKConfig
+
+# Keep a dedicated workspace separate from the installed algorithm library.
+WORKSPACE_ALGOS_SUBDIR = "workspace_algorithms"
+
+
+def get_workspace_dir(config: SDKConfig) -> Path:
+    """Return the workspace directory for editable algorithms."""
+    workspace = config.sdk_home / WORKSPACE_ALGOS_SUBDIR
+    workspace.mkdir(parents=True, exist_ok=True)
+    return workspace
+
+
+def run_workspace_script(workspace: Path, script: str, timeout: int = 30) -> subprocess.CompletedProcess:
+    """Run a Python snippet with the workspace on PYTHONPATH."""
+    pythonpath = [str(workspace)]
+    existing = os.environ.get("PYTHONPATH")
+    if existing:
+        pythonpath.append(existing)
+
+    env = {
+        **os.environ,
+        "PYTHONPATH": os.pathsep.join(pythonpath),
+        "PYTHONUNBUFFERED": "1",
+    }
+
+    return subprocess.run(
+        [sys.executable, "-c", script],
+        cwd=workspace,
+        env=env,
+        capture_output=True,
+        text=True,
+        timeout=timeout,
+    )

{fraclab_sdk-0.1.0.dist-info → fraclab_sdk-0.1.1.dist-info}/METADATA

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: fraclab-sdk
-Version: 0.1.0
+Version: 0.1.1
 Summary: SDK for managing snapshots, algorithms, and run execution
 Requires-Python: >=3.11,<4.0
 Classifier: Programming Language :: Python :: 3
@@ -8,19 +8,22 @@ Classifier: Programming Language :: Python :: 3.11
 Classifier: Programming Language :: Python :: 3.12
 Classifier: Programming Language :: Python :: 3.13
 Classifier: Programming Language :: Python :: 3.14
+Provides-Extra: workbench
 Requires-Dist: fastapi (>=0.115.0,<0.116.0)
 Requires-Dist: matplotlib (>=3.9.2,<4.0.0)
 Requires-Dist: numpy (>=2.1.1,<3.0.0)
 Requires-Dist: pandas (>=2.2.3,<3.0.0)
+Requires-Dist: pyarrow (>=16.0.0) ; extra == "workbench"
 Requires-Dist: pydantic (>=2.10.0,<3.0.0)
 Requires-Dist: rich (>=13.9.0,<14.0.0)
 Requires-Dist: scipy (>=1.13.1,<2.0.0)
+Requires-Dist: streamlit (>=1.30) ; extra == "workbench"
 Requires-Dist: typer (>=0.15.0,<0.16.0)
 Description-Content-Type: text/markdown
 
 # Fraclab SDK Reference
 
-> 版本: 0.1.0
+> 版本: 0.1.1
 > Python: >=3.11
 
 Fraclab SDK 是一个算法开发与执行框架，帮助算法开发者快速构建、测试和部署数据处理算法。
@@ -43,12 +46,26 @@ Fraclab SDK 是一个算法开发与执行框架，帮助算法开发者快速
 
 ## 安装
 
-使用 wheel 文件安装：
+轻量安装（核心 SDK / CLI，自动带上科学计算依赖）：
 
 ```bash
-pip install fraclab_sdk-0.1.0-py3-none-any.whl
+pip install fraclab-sdk
 ```
 
+安装并启用 Workbench UI：
+
+```bash
+pip install "fraclab-sdk[workbench]"
+fraclab-workbench           # CLI entry point
+# 或
+python -m fraclab_sdk.workbench
+```
+
+### 依赖说明
+
+- 核心安装会自动安装并锁定：`numpy>=2.1.1`, `pandas>=2.2.3`, `scipy>=1.13.1`, `matplotlib>=3.9.2`, `fastapi>=0.115.0`, `rich>=13.9.0`。无需手动再装，避免版本冲突。
+- 可选 `workbench` 额外安装 UI 依赖：`streamlit>=1.30`, `pyarrow>=16.0.0`（`pandas` 已在核心里）。
+
 ---
 
 ## 快速开始：编写你的第一个算法
@@ -66,13 +83,63 @@ from fraclab_sdk.runtime import DataClient, ArtifactWriter
 
 ### 2. 编写算法入口
 
-创建 `main.py` 作为算法入口文件：
+创建 `main.py` 作为算法入口文件。
+
+#### 入口函数签名约定
+
+**算法入口函数必须严格遵循以下签名:**
+
+```python
+def run(ctx):
+    ...
+```
+
+| 约定 | 要求 | 说明 |
+|------|------|------|
+| 文件名 | `main.py` | 必须是 `main.py`，不能是其他名称 |
+| 函数名 | `run` | 必须是 `run`，区分大小写 |
+| 参数 | 仅 `ctx` 一个参数 | SDK 使用 `module.run(ctx)` 调用，**不支持**其他签名 |
+| 返回值 | 无要求 | 返回值会被忽略 |
+
+> **警告**: 以下写法都会导致运行失败:
+> ```python
+> # ❌ 错误: 参数名不影响，但参数个数必须是 1
+> def run(ctx, extra_arg):  # TypeError: run() missing required argument
+>
+> # ❌ 错误: 函数名错误
+> def execute(ctx):  # AttributeError: module has no attribute 'run'
+>
+> # ❌ 错误: 放在其他文件
+> # algorithm.py 中定义 run()  # 不会被加载
+> ```
+
+#### 最小可运行模板
 
 ```python
 # main.py
-from fraclab_sdk.runtime import DataClient, ArtifactWriter
-from pathlib import Path
+def run(ctx):
+    """算法入口函数 - 最小模板。
+
+    Args:
+        ctx: RunContext，包含:
+            - ctx.data_client: DataClient 实例
+            - ctx.params: dict[str, Any]，用户参数
+            - ctx.artifacts: ArtifactWriter 实例
+            - ctx.logger: logging.Logger 实例
+            - ctx.run_context: dict，运行上下文
+    """
+    logger = ctx.logger
+    logger.info("算法开始执行")
+
+    # 你的逻辑...
+
+    logger.info("算法执行完成")
+```
+
+#### 完整示例
 
+```python
+# main.py
 def run(ctx):
     """算法入口函数。
 
@@ -333,7 +400,7 @@ aw.write_scalar(
     "drsPath": "dist/drs.json"
   },
   "requires": {
-    "sdk": "0.1.0",
+    "sdk": "0.1.1",
     "core": "1.0.0"
   },
   "repository": "https://github.com/example/my-algorithm",

{fraclab_sdk-0.1.0.dist-info → fraclab_sdk-0.1.1.dist-info}/RECORD

@@ -1,4 +1,4 @@
-README.md,sha256=M6jzlivo3RM9xT8zoHprRD_dbYK0psdn_EGE7Of9Y6c,42564
+README.md,sha256=XK2y0q8psA07V2QQHVSFLN4jpZVq5dLHgViwNYck_8M,44415
 fraclab_sdk/__init__.py,sha256=6SycB79WDBLT3QwAWVEMVHMOz_vETyo3ZZ0IbAsmTPE,924
 fraclab_sdk/algorithm/__init__.py,sha256=-tAQkdAWWh_MlQMszsz0XAUR9aJ8oOxu8gUsUTmLyHA,220
 fraclab_sdk/algorithm/export.py,sha256=axOWsDUF6K5Ru2eIb0hcjk8t4md4u-gnZGjK3JaRoGo,39
@@ -39,9 +39,26 @@ fraclab_sdk/snapshot/__init__.py,sha256=RPp-tt85xnecO4tkXLl1BClcjxVKvmAnhlpyomRz
 fraclab_sdk/snapshot/index.py,sha256=8hsRm6QB1taDhUk6cLqkrxQWzwj6E05I0YLB5S0H3Ms,2942
 fraclab_sdk/snapshot/library.py,sha256=3rq2s7nirI5blOzfGet1rtuk-f18qOq5MuAsUP2ruZw,7000
 fraclab_sdk/snapshot/loader.py,sha256=ni9gdFQjAcIavdA9AoMMMtEJeEypOzK0dEbvygaaAh4,7578
+fraclab_sdk/specs/__init__.py,sha256=aOQ8FBSgRLmJGDYZFMOKqhWu0O1YllQcIZfC_gK-Oqs,452
 fraclab_sdk/specs/manifest.py,sha256=D3CyMt07p_uBI5Dw0NFfzUhzS2JZafaGxuxXFZ8J938,2597
+fraclab_sdk/specs/output.py,sha256=Tg1eT6f31TaeKj8pZUABzXJeO55H5ieWAldw93iyRiY,729
 fraclab_sdk/utils/io.py,sha256=L4EoReyx13wQqj0qaloMcNGSuEanZDHEk5A8rI-OCJQ,786
-fraclab_sdk-0.1.0.dist-info/METADATA,sha256=zzxbqZvIESl9b1EpY2WNnrBlfrbPsGHS9KZXZLERaz4,43333
-fraclab_sdk-0.1.0.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
-fraclab_sdk-0.1.0.dist-info/entry_points.txt,sha256=DItrlEkztJy6iRBqOYj4XpMN6GVlHOcluAqhsL3QnSg,104
-fraclab_sdk-0.1.0.dist-info/RECORD,,
+fraclab_sdk/workbench/Home.py,sha256=RhSNLH3t3m6LYIrBaryrsME8z5m4BrGDCTdYA352ig8,4487
+fraclab_sdk/workbench/__init__.py,sha256=eZnXHbvRbv6unD1BZ4T7SmyYMF1UKd-Nt6t11QuYSvM,204
+fraclab_sdk/workbench/__main__.py,sha256=Pkh79m5GnE20HlY72c4-7nshpy39jqkkbEIJ5k1lL1g,1333
+fraclab_sdk/workbench/pages/1_Snapshots.py,sha256=522dIziu8-ZuSqI8y_ikeeAYukU0cPV5DcOVZM_awo8,21075
+fraclab_sdk/workbench/pages/2_Browse.py,sha256=yqS0AfBVF4FXtb17elQ9oxU6fTuzl5XLk8c5f8xIW8c,17283
+fraclab_sdk/workbench/pages/3_Selection.py,sha256=q2o_OF5AWa-tZFmJ2XAlVHcAWYKJAIYKncM9Egi8Wog,18319
+fraclab_sdk/workbench/pages/4_Run.py,sha256=BIdzJ7ulWvD84XrIh_7xQ4O1nSuKDfARlAQ4AKJnFFc,12705
+fraclab_sdk/workbench/pages/5_Results.py,sha256=7ZHID3LUDX7eRW38he0jzcF3rlJNy9CFRDwFgMuwuK8,11305
+fraclab_sdk/workbench/pages/6_Algorithm_Edit.py,sha256=nkTv2rQgLQoiXB-RoS8RgUksv0CFhL0hmF0hvH2akNI,4113
+fraclab_sdk/workbench/pages/7_Schema_Edit.py,sha256=PA_5FaPdGdVdO6n3MONCU9_6k3oYMK4DNZUhA0_IKhs,5019
+fraclab_sdk/workbench/pages/8_Output_Edit.py,sha256=CcdBCdK-6YNE1P8cud0mx2zXcYlLAuRwbnv7n-7GLSs,5080
+fraclab_sdk/workbench/pages/9_Export_Algorithm.py,sha256=3YaHc5K4zvxR0K-JS8sk_q59cbK-I6i9F1CdEKZBcpQ,8561
+fraclab_sdk/workbench/pages/__init__.py,sha256=Et0iV4dhbgkeKKuhmffpYzhDjvWM7IheHh3feDQ4J2M,54
+fraclab_sdk/workbench/ui_styles.py,sha256=o06r6Cv1VV8ita2-tmcGYxbdL6-JkPSY2K3AvnSYhuw,2656
+fraclab_sdk/workbench/utils.py,sha256=0rcKo8_zIYHQ2kwuEjAf15ara6okpJViFPyW2F_SPx4,1179
+fraclab_sdk-0.1.1.dist-info/METADATA,sha256=EsM2mrdD3yBelfuq1SmdMNkCJg0f1jRJkwFiVg5P_fw,45324
+fraclab_sdk-0.1.1.dist-info/WHEEL,sha256=zp0Cn7JsFoX2ATtOhtaFYIiE2rmFAD4OcMhtUki8W3U,88
+fraclab_sdk-0.1.1.dist-info/entry_points.txt,sha256=R6jqSgmf7jB4xMgsTe0M-X9j6JtQQfaedku4Dppmwww,158
+fraclab_sdk-0.1.1.dist-info/RECORD,,

{fraclab_sdk-0.1.0.dist-info → fraclab_sdk-0.1.1.dist-info}/entry_points.txt

@@ -1,4 +1,5 @@
 [console_scripts]
 fraclab-runner=fraclab_sdk.runtime.runner_main:main
 fraclab-sdk=fraclab_sdk.cli:main
+fraclab-workbench=fraclab_sdk.workbench.__main__:main