scitex-sdk 0.1.0__tar.gz

scitex_sdk-0.1.0/.github/workflows/pypi-publish-and-github-release-on-tag.yml

@@ -0,0 +1,146 @@
+name: release
+
+# Tag-driven release pipeline — GITHUB-HOSTED (ubuntu-latest), copied from
+# scitex-app's release contract and trimmed of the scitex-app-specific
+# "verify skills docs are in the wheel" block (scitex-sdk ships no _skills).
+#
+# Operator flow:  git tag v0.1.0 && git push origin v0.1.0
+#   1. test    — pytest (the facade identity tests). Must pass or nothing publishes.
+#   2. build   — wheel + sdist.
+#   3. publish — PyPI via trusted publishing (pypa/gh-action-pypi-publish).
+#   4. release — GitHub Release with CHANGELOG notes.
+#
+# TRUSTED PUBLISHING matches on (repository, workflow FILENAME, environment).
+# This file must keep its name (pypi-p...-tag.yml) and the publish job must keep
+# `environment: pypi`, or the PyPI trust config for scitex-sdk will not match.
+# The operator registers the PyPI project + trusted publisher for
+# (scitex-ai/scitex-sdk, pypi-p...-tag.yml, pypi) BEFORE the first tag is pushed.
+
+on:
+  push:
+    tags: ['v*']
+  workflow_dispatch:
+    inputs:
+      version:
+        description: 'Tag to publish (e.g. v0.1.0) — must already exist on the repo'
+        required: true
+        type: string
+
+jobs:
+  test:
+    runs-on: ubuntu-latest
+    strategy:
+      fail-fast: false
+      matrix:
+        python-version: ["3.11", "3.12", "3.13"]
+    steps:
+      - name: Resolve version
+        id: ver
+        run: |
+          if [ "${{ github.event_name }}" = "push" ]; then
+            v="${GITHUB_REF#refs/tags/}"
+          else
+            v="${{ inputs.version }}"
+          fi
+          echo "version=$v" >> "$GITHUB_OUTPUT"
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ steps.ver.outputs.version }}
+          fetch-depth: 0
+      - name: Set up Python ${{ matrix.python-version }}
+        uses: actions/setup-python@v5
+        with:
+          python-version: ${{ matrix.python-version }}
+      - name: Install dependencies
+        run: |
+          python -m pip install --upgrade pip
+          # The facade installs both halves (scitex-app, scitex-ui) as
+          # dependencies, plus pytest. There is no [all] extra / dev group in
+          # this thin package, so a plain pip install is correct here.
+          pip install -e . pytest
+      - name: Run tests
+        run: pytest tests/
+
+  build:
+    needs: test
+    runs-on: ubuntu-latest
+    outputs:
+      version: ${{ steps.ver.outputs.version }}
+    steps:
+      - name: Resolve version
+        id: ver
+        run: |
+          if [ "${{ github.event_name }}" = "push" ]; then
+            v="${GITHUB_REF#refs/tags/}"
+          else
+            v="${{ inputs.version }}"
+          fi
+          echo "version=$v" >> "$GITHUB_OUTPUT"
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ steps.ver.outputs.version }}
+          fetch-depth: 0
+      - name: Set up Python
+        uses: actions/setup-python@v5
+        with:
+          python-version: "3.12"
+      - name: Build wheel + sdist
+        run: |
+          python -m pip install --upgrade pip build
+          python -m build
+          # fail-loud: an empty dist/ must stop the pipeline here.
+          ls -1 dist/*.whl dist/*.tar.gz >/dev/null
+      - uses: actions/upload-artifact@v4
+        with:
+          name: dist
+          path: dist/
+
+  publish:
+    needs: build
+    runs-on: ubuntu-latest
+    environment:
+      name: pypi
+      url: https://pypi.org/p/scitex-sdk
+    permissions:
+      id-token: write
+    steps:
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+      - name: Publish to PyPI (trusted publishing)
+        uses: pypa/gh-action-pypi-publish@release/v1
+
+  release:
+    needs: [build, publish]
+    runs-on: ubuntu-latest
+    permissions:
+      contents: write
+    steps:
+      - uses: actions/checkout@v4
+        with:
+          ref: ${{ needs.build.outputs.version }}
+      - uses: actions/download-artifact@v4
+        with:
+          name: dist
+          path: dist
+      - name: Extract release notes from CHANGELOG.md
+        run: |
+          VERSION="${{ needs.build.outputs.version }}"
+          VERSION="${VERSION#v}"
+          awk -v v="$VERSION" '
+            $0 ~ "^## \\\[" v "\\\\]" {p=1; next}
+            p && /^## \[/ {exit}
+            p
+          ' CHANGELOG.md > release-notes.md || true
+          if [ ! -s release-notes.md ]; then
+            echo "Release v${VERSION}. See CHANGELOG.md for details." > release-notes.md
+          fi
+      - name: Create GitHub Release
+        env:
+          GH_TOKEN: ${{ secrets.GITHUB_TOKEN }}
+        run: |
+          gh release create "${{ needs.build.outputs.version }}" \
+            --title "${{ needs.build.outputs.version }}" \
+            --notes-file release-notes.md \
+            dist/*

scitex_sdk-0.1.0/CHANGELOG.md

@@ -0,0 +1,28 @@
+# Changelog
+
+All notable changes to `scitex-sdk`.
+
+The versioning here is the **umbrella** release (the facade + the gradually
+moving implementation). Each half keeps its own version through the migration
+window: `scitex_app.__version__` (scitex-app) and `scitex_ui.__version__`
+(scitex-ui). See ADR 0001 (scitex-app) and ADR 0003 (scitex-ui).
+
+## [0.1.0] — 2026-09-14
+
+### Added
+- `scitex_sdk.app` — facade re-exporting `scitex_app`'s documented public
+  surface (18 names) **by identity** (`scitex_sdk.app.X is scitex_app.X`).
+- `scitex_sdk.ui` — facade re-exporting `scitex_ui`'s documented public
+  surface (5 names) by identity.
+- `tests/test_facade_identity.py` — asserts every re-export is the identical
+  object as the original (the bar that makes the consumer import rewrite
+  mechanical + behavior-neutral).
+
+### Notes
+- The facade `depends on` `scitex-app>=0.24.0` + `scitex-ui>=0.20.3` (the
+  published floors); it does not vendor them yet.
+- No consumer-visible behavior change: `scitex-sdk` is additive. The original
+  `scitex-app` / `scitex-ui` distributions are untouched at this step; they
+  become thin compat shims only in a later step.
+- Facade-first decision + the app/ui boundary-kept-inside-the-SDK rule: ADR
+  0001 (scitex-app), ADR 0003 (scitex-ui).

scitex_sdk-0.1.0/PKG-INFO

@@ -0,0 +1,48 @@
+Metadata-Version: 2.5
+Name: scitex-sdk
+Version: 0.1.0
+Summary: SciTeX SDK — one project for the app contract (scitex_sdk.app) + UI shell (scitex_sdk.ui). Step 1: thin facade re-exporting scitex-app + scitex-ui; implementation consolidates gradually.
+Requires-Python: >=3.10
+Requires-Dist: scitex-app>=0.24.0
+Requires-Dist: scitex-ui>=0.20.3
+Description-Content-Type: text/markdown
+
+# scitex-sdk
+
+One project for the SciTeX **app contract** + **UI shell** — so the two are
+named, versioned, and released as a single unit.
+
+```
+scitex_sdk.app   ->  the app contract   (from scitex-app)
+scitex_sdk.ui    ->  the UI shell       (from scitex-ui)
+```
+
+## Step 1: thin facade
+
+`scitex_sdk.app` re-exports `scitex_app`'s documented public surface **by
+identity** (the same objects), and `scitex_sdk.ui` re-exports `scitex_ui`'s.
+That makes a consumer's import rewrite mechanical and behavior-neutral:
+
+```python
+# before
+from scitex_app import get_files
+# after
+from scitex_sdk.app import get_files   # identical object
+```
+
+`tests/test_facade_identity.py` asserts every re-export is the *same object*
+as the original — a copy or reimplementation fails the suite.
+
+## Roadmap
+
+1. **Facade (this)** — re-export, identity tests, release. Consumers can start
+   rewriting imports against it.
+2. **Gradual implementation move** — code moves from `scitex_app` /
+   `scitex_ui` into `scitex_sdk.app` / `scitex_sdk.ui`; the original
+   distributions stay as thin compat shims until every consumer has migrated.
+3. **Shim removal** — only after all consumers (hub, figrecipe, writer,
+   scholar, cards, agent-container GUI) are on `scitex_sdk`.
+
+The static/TS/CSS assets live in `scitex_ui` today (Django's
+AppDirectoriesFinder resolves them by the `scitex_ui` app label); they move
+with the implementation step, not the facade.

scitex_sdk-0.1.0/README.md

@@ -0,0 +1,39 @@
+# scitex-sdk
+
+One project for the SciTeX **app contract** + **UI shell** — so the two are
+named, versioned, and released as a single unit.
+
+```
+scitex_sdk.app   ->  the app contract   (from scitex-app)
+scitex_sdk.ui    ->  the UI shell       (from scitex-ui)
+```
+
+## Step 1: thin facade
+
+`scitex_sdk.app` re-exports `scitex_app`'s documented public surface **by
+identity** (the same objects), and `scitex_sdk.ui` re-exports `scitex_ui`'s.
+That makes a consumer's import rewrite mechanical and behavior-neutral:
+
+```python
+# before
+from scitex_app import get_files
+# after
+from scitex_sdk.app import get_files   # identical object
+```
+
+`tests/test_facade_identity.py` asserts every re-export is the *same object*
+as the original — a copy or reimplementation fails the suite.
+
+## Roadmap
+
+1. **Facade (this)** — re-export, identity tests, release. Consumers can start
+   rewriting imports against it.
+2. **Gradual implementation move** — code moves from `scitex_app` /
+   `scitex_ui` into `scitex_sdk.app` / `scitex_sdk.ui`; the original
+   distributions stay as thin compat shims until every consumer has migrated.
+3. **Shim removal** — only after all consumers (hub, figrecipe, writer,
+   scholar, cards, agent-container GUI) are on `scitex_sdk`.
+
+The static/TS/CSS assets live in `scitex_ui` today (Django's
+AppDirectoriesFinder resolves them by the `scitex_ui` app label); they move
+with the implementation step, not the facade.

scitex_sdk-0.1.0/pyproject.toml

@@ -0,0 +1,20 @@
+[project]
+name = "scitex-sdk"
+version = "0.1.0"
+description = "SciTeX SDK — one project for the app contract (scitex_sdk.app) + UI shell (scitex_sdk.ui). Step 1: thin facade re-exporting scitex-app + scitex-ui; implementation consolidates gradually."
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "scitex-app>=0.24.0",
+    "scitex-ui>=0.20.3",
+]
+
+[build-system]
+requires = ["hatchling"]
+build-backend = "hatchling.build"
+
+[tool.hatch.build.targets.wheel]
+packages = ["src/scitex_sdk"]
+
+[tool.pytest.ini_options]
+testpaths = ["tests"]

scitex_sdk-0.1.0/src/scitex_sdk/__init__.py

@@ -0,0 +1,17 @@
+"""scitex-sdk — one project for the app contract + the UI shell.
+
+Step 1 (thin facade):
+  - ``scitex_sdk.app`` re-exports ``scitex_app`` (the app contract).
+  - ``scitex_sdk.ui`` re-exports ``scitex_ui`` (the UI shell + assets).
+
+Re-exports are the SAME objects as the originals (identity, not copies) —
+verified by ``tests/test_facade_identity.py`` — so consumers can switch
+``scitex_app`` -> ``scitex_sdk.app`` (and ``scitex_ui`` -> ``scitex_sdk.ui``)
+mechanically with zero behavior change. The implementation moves INTO
+scitex-sdk gradually after this facade releases; the original distributions
+stay as thin compat shims until every consumer has migrated.
+"""
+
+from scitex_sdk import app, ui  # noqa: F401
+
+__all__ = ["app", "ui"]

scitex_sdk-0.1.0/src/scitex_sdk/app.py

@@ -0,0 +1,54 @@
+"""scitex_sdk.app — the app contract (facade over ``scitex_app``).
+
+Step 1 re-exports the documented public surface of ``scitex_app`` by IDENTITY
+(the same function/class/submodule objects), so ``from scitex_sdk.app import
+get_files`` is the same object as ``from scitex_app import get_files``. The
+implementation moves here gradually after the facade releases.
+"""
+
+from __future__ import annotations
+
+from scitex_app import (
+    FilesBackend,
+    build_tree,
+    chat,
+    copy_file,
+    delete_file,
+    embed,
+    file_exists,
+    get_files,
+    hosts_to_allow,
+    list_files,
+    paths,
+    read_file,
+    register_backend,
+    rename_file,
+    scaffold,
+    validate,
+    validator,
+    write_file,
+)
+
+__version__ = "0.1.0"  # facade version; the app contract's own version is scitex_app.__version__
+
+__all__ = [
+    "FilesBackend",
+    "build_tree",
+    "chat",
+    "copy_file",
+    "delete_file",
+    "embed",
+    "file_exists",
+    "get_files",
+    "hosts_to_allow",
+    "list_files",
+    "paths",
+    "read_file",
+    "register_backend",
+    "rename_file",
+    "scaffold",
+    "validate",
+    "validator",
+    "write_file",
+    "__version__",
+]

scitex_sdk-0.1.0/src/scitex_sdk/ui.py

@@ -0,0 +1,30 @@
+"""scitex_sdk.ui — the UI shell + assets (facade over ``scitex_ui``).
+
+Step 1 re-exports the documented public surface of ``scitex_ui`` by IDENTITY,
+so ``from scitex_sdk.ui import get_component`` is the same object as
+``from scitex_ui import get_component``. The implementation moves here
+gradually after the facade releases; the static/TS/CSS assets stay in
+scitex_ui until that move (Django's AppDirectoriesFinder resolves them by the
+``scitex_ui`` app label, which the facade does not change).
+"""
+
+from __future__ import annotations
+
+from scitex_ui import (
+    get_component,
+    get_docs_path,
+    get_static_dir,
+    list_components,
+    register_component,
+)
+
+__version__ = "0.1.0"  # facade version; the shell's own version is scitex_ui.__version__
+
+__all__ = [
+    "get_component",
+    "get_docs_path",
+    "get_static_dir",
+    "list_components",
+    "register_component",
+    "__version__",
+]

scitex_sdk-0.1.0/tests/test_facade_identity.py

@@ -0,0 +1,71 @@
+"""Facade identity tests — the contract that makes the import rewrite safe.
+
+Every name re-exported by ``scitex_sdk.app`` / ``scitex_sdk.ui`` must be the
+SAME object (identity) as the corresponding name in ``scitex_app`` /
+``scitex_ui``. That is what lets a consumer rewrite
+``from scitex_app import X`` -> ``from scitex_sdk.app import X`` mechanically
+with zero behavior change. A copy or a reimplementation would break this.
+"""
+
+from __future__ import annotations
+
+import scitex_app
+import scitex_ui
+from scitex_sdk import app, ui
+
+
+def _assert_identity(facade_module, source_module, name):
+    assert getattr(facade_module, name) is getattr(source_module, name), (
+        f"scitex_sdk facade re-export {name!r} is not identical to "
+        f"{source_module.__name__}.{name}"
+    )
+
+
+# The names the facade re-exports. Kept in sync with scitex_sdk/app.py and
+# scitex_sdk/ui.py __all__ (minus the facade's own __version__).
+_APP_NAMES = [
+    "FilesBackend",
+    "build_tree",
+    "chat",
+    "copy_file",
+    "delete_file",
+    "embed",
+    "file_exists",
+    "get_files",
+    "hosts_to_allow",
+    "list_files",
+    "paths",
+    "read_file",
+    "register_backend",
+    "rename_file",
+    "scaffold",
+    "validate",
+    "validator",
+    "write_file",
+]
+_UI_NAMES = [
+    "get_component",
+    "get_docs_path",
+    "get_static_dir",
+    "list_components",
+    "register_component",
+]
+
+
+def test_app_facade_reexports_by_identity():
+    for name in _APP_NAMES:
+        _assert_identity(app, scitex_app, name)
+
+
+def test_ui_facade_reexports_by_identity():
+    for name in _UI_NAMES:
+        _assert_identity(ui, scitex_ui, name)
+
+
+def test_facade_modules_are_distinct_from_each_other():
+    assert app is not ui
+
+
+def test_facade_carries_its_own_version_string():
+    # The facade declares its own version; it must be a real version string.
+    assert app.__version__ == ui.__version__ == "0.1.0"