flyteplugins-union 0.2.2__tar.gz → 0.4.0__tar.gz

{flyteplugins_union-0.2.2/src/flyteplugins_union.egg-info → flyteplugins_union-0.4.0}/PKG-INFO

@@ -1,6 +1,6 @@
 Metadata-Version: 2.4
 Name: flyteplugins-union
-Version: 0.2.2
+Version: 0.4.0
 Summary: Union SDK - Proprietary extensions for Flyte
 Author-email: unionai <info@union.ai>
 Project-URL: Homepage, https://www.union.ai/
@@ -17,11 +17,15 @@ Classifier: Topic :: Software Development
 Requires-Python: >=3.10
 Description-Content-Type: text/markdown
 License-File: LICENSE
+Requires-Dist: aiosqlite>=0.20.0
 Requires-Dist: connectrpc>=0.9.0
-Requires-Dist: flyte<2.2.0,>=2.1.0
+Requires-Dist: flyte<2.5.0,>=2.3.0
 Requires-Dist: flyteidl2>=2.0.0
+Requires-Dist: kubernetes>=27.2.0
 Requires-Dist: pyyaml>=6.0
 Requires-Dist: rich-click>=1.8.0
+Provides-Extra: tui
+Requires-Dist: textual>=0.85; extra == "tui"
 Dynamic: license-file
 
 # Union Flyte Plugin

{flyteplugins_union-0.2.2 → flyteplugins_union-0.4.0}/licenses/BSL.txt

@@ -17,7 +17,7 @@ Additional Use Grant: You may make use of the Licensed Work, provided that
                       computer programs whose source code are controlled by
                       such third parties.
 
-Change Date:          2030-03-31
+Change Date:          2030-06-03
 
 Change License:       Apache License, Version 2.0
 

flyteplugins_union-0.4.0/pyproject.toml

@@ -0,0 +1,178 @@
+[build-system]
+requires = ["setuptools", "setuptools_scm"]
+build-backend = "setuptools.build_meta"
+
+[project]
+name = "flyteplugins-union"
+dynamic = ["version"]
+authors = [{ name = "unionai", email = "info@union.ai" }]
+description = "Union SDK - Proprietary extensions for Flyte"
+readme = "README.md"
+requires-python = ">=3.10"
+dependencies = [
+    "aiosqlite>=0.20.0",
+    "connectrpc>=0.9.0",
+    "flyte>=2.3.0,<2.5.0",
+    "flyteidl2>=2.0.0",
+    "kubernetes>=27.2.0",
+    "pyyaml>=6.0",
+    "rich-click>=1.8.0",
+]
+classifiers = [
+    "Intended Audience :: Science/Research",
+    "Intended Audience :: Developers",
+    "License :: Other/Proprietary License",
+    "Programming Language :: Python :: 3.10",
+    "Programming Language :: Python :: 3.11",
+    "Programming Language :: Python :: 3.12",
+    "Programming Language :: Python :: 3.13",
+    "Topic :: Scientific/Engineering",
+    "Topic :: Software Development",
+]
+
+[project.optional-dependencies]
+# Interactive TUI surface for `flyte explore volume` and friends. Kept
+# optional so headless installs (runtime container images) don't pull
+# the textual / rich-pixels / linkify-it tree. The `dev` group below
+# pulls it in so the TUI tests run in CI.
+tui = ["textual>=0.85"]
+
+[dependency-groups]
+dev = [
+    "build>=1.2.2.post1",
+    "mock>=5.2.0",
+    "pytest>=8.3.5",
+    "pytest-asyncio>=0.26.0",
+    "pytest-benchmark>=5.1.0",
+    "ruff>=0.11.0",
+    "setuptools-scm>=8.2.0",
+    "mypy>=1.16.0",
+    "wheel>=0.47.0",
+    # Run the full test suite (incl. the `flyte explore volume` TUI tests,
+    # which import textual) in CI / local dev.
+    "textual>=0.85",
+    # ty: Astral's (ruff/uv team) Rust type checker. Pre-1.0/preview, so
+    # pin a floor and expect the rule surface to keep moving.
+    "ty>=0.0.39",
+]
+
+[tool.check-manifest]
+# The `.gitkeep` only exists to keep the juicefs `bin/` dir in git; the binary
+# is dropped in at wheel-build time (see maint_tools/bundle_juicefs.py). It's
+# tracked but intentionally not shipped in the sdist.
+ignore = [
+    "src/flyteplugins/union/io/_internal/_juicefs/bin/.gitkeep",
+]
+
+[tool.ty.src]
+# Generated protobuf stubs are not worth type-checking (ruff excludes them too).
+exclude = ["src/flyteplugins/union/internal"]
+
+[tool.setuptools_scm]
+
+[project.urls]
+Homepage = "https://www.union.ai/"
+Documentation = "https://docs.union.ai/"
+
+[project.entry-points."flyte.plugins.cli.commands"]
+# CLI plugins for Union commands
+"create.api-key" = "flyteplugins.union.cli.api_key:create_api_key"
+"delete.api-key" = "flyteplugins.union.cli.api_key:delete_api_key"
+"get.api-key" = "flyteplugins.union.cli.api_key:get_api_key"
+"create.role" = "flyteplugins.union.cli.role:create_role"
+"get.role" = "flyteplugins.union.cli.role:get_role"
+"delete.role" = "flyteplugins.union.cli.role:delete_role"
+"update.role" = "flyteplugins.union.cli.role:update_role"
+"create.policy" = "flyteplugins.union.cli.policy:create_policy"
+"get.policy" = "flyteplugins.union.cli.policy:get_policy"
+"delete.policy" = "flyteplugins.union.cli.policy:delete_policy"
+"update.policy" = "flyteplugins.union.cli.policy:update_policy"
+"create.user" = "flyteplugins.union.cli.user:create_user"
+"get.user" = "flyteplugins.union.cli.user:get_user"
+"delete.user" = "flyteplugins.union.cli.user:delete_user"
+"get.member" = "flyteplugins.union.cli.member:get_member"
+"create.cluster" = "flyteplugins.union.cli.cluster:create_cluster"
+"get.cluster" = "flyteplugins.union.cli.cluster:get_cluster"
+"delete.cluster" = "flyteplugins.union.cli.cluster:delete_cluster"
+"create.cluster-pool" = "flyteplugins.union.cli.cluster_pool:create_cluster_pool"
+"get.cluster-pool" = "flyteplugins.union.cli.cluster_pool:get_cluster_pool"
+"update.cluster-pool" = "flyteplugins.union.cli.cluster_pool:update_cluster_pool"
+"delete.cluster-pool" = "flyteplugins.union.cli.cluster_pool:delete_cluster_pool"
+"create.queue" = "flyteplugins.union.cli.queue:create_queue"
+"get.queue" = "flyteplugins.union.cli.queue:get_queue"
+"update.queue" = "flyteplugins.union.cli.queue:update_queue"
+"create.assignment" = "flyteplugins.union.cli.assignment:create_assignment"
+"get.assignment" = "flyteplugins.union.cli.assignment:get_assignment"
+"delete.assignment" = "flyteplugins.union.cli.assignment:delete_assignment"
+# Top-level `flyte explore` group (a single click.Group with a `volume`
+# subcommand → `flyte explore volume`). Registered as a top-level group rather
+# than an `explore.volume` entry because the plugin loader won't auto-create a
+# missing `explore` verb group (it warns + skips).
+"explore" = "flyteplugins.union.cli.volume:explore"
+
+[project.entry-points."flyte.plugins.types"]
+# Custom TypeTransformer that auto-commits a still-mounted Volume at
+# task-return time. Loaded by flyte's TypeEngine on first use; no
+# explicit user-side registration needed.
+"flyteplugins.union.volume" = "flyteplugins.union.io._volume_transformer:register_volume_type"
+
+[tool.setuptools]
+include-package-data = true
+
+[tool.setuptools.package-data]
+# Platform-specific wheels stage the juicefs binary here (see
+# maint_tools/bundle_juicefs.py). The sdist ships an empty bin/ — runtime
+# resolver falls back to `juicefs` on PATH when no bundled binary is
+# present.
+"flyteplugins.union.io._internal._juicefs" = ["bin/juicefs", "bin/juicefs.exe"]
+
+[tool.setuptools.packages.find]
+where = ["src"]
+include = ["flyteplugins*"]
+
+[tool.ruff]
+line-length = 120
+extend-exclude = ["src/flyteplugins/union/internal"]
+
+[tool.ruff.lint]
+select = [
+    "E",
+    "W",
+    "F",
+    "I",
+    "PLW",
+    "YTT",
+    "ASYNC",
+    "C4",
+    "T10",
+    "EXE",
+    "ISC",
+    "LOG",
+    "PIE",
+    "Q",
+    "RSE",
+    "FLY",
+    "PGH",
+    "PLC",
+    "PLE",
+    "PLW",
+    "FURB",
+    "RUF",
+]
+
+[tool.ruff.lint.per-file-ignores]
+# Volume code wraps sync subprocess / pathlib ops in asyncio.to_thread inside
+# async methods; ASYNC240 fires on the inner sync calls but they're never
+# executed on the event loop. PLC0415 fires on the late ``import kubernetes``
+# inside volume_pod_template() — that's intentional so the dep is only loaded
+# when callers actually build a pod template.
+"src/flyteplugins/union/io/**/*.py" = ["ASYNC240", "PLC0415"]
+"tests/unit/test_volume.py" = ["ASYNC240", "PLC0415"]
+# Volume CLI lazy-imports Volume/textual/asyncio so plain --help and
+# headless installs don't pay the runtime/optional-dep import cost.
+"src/flyteplugins/union/cli/volume.py" = ["PLC0415"]
+"src/flyteplugins/union/cli/_volume_index.py" = ["PLC0415"]
+"src/flyteplugins/union/cli/_tui/**/*.py" = ["PLC0415"]
+# VolumeExplore lazy-imports flyte.io / msgpack / boto3 / the Volume model so
+# `import flyteplugins.union.remote` stays light for non-volume callers.
+"src/flyteplugins/union/remote/_volume_explore.py" = ["PLC0415"]

flyteplugins_union-0.4.0/src/flyteplugins/union/cli/_tui/__init__.py

@@ -0,0 +1,67 @@
+"""Lazy entrypoint for the volume explore TUI.
+
+Importing ``textual`` is gated behind the ``[tui]`` extra so headless
+installs don't pay the cost. The launcher below catches the
+:class:`ImportError` and re-raises with a clear install hint, matching the
+ergonomic of :mod:`flyte.cli._tui` upstream.
+"""
+
+from __future__ import annotations
+
+from typing import TYPE_CHECKING
+
+if TYPE_CHECKING:
+    from flyteplugins.union.cli._volume_index import IndexReader
+
+
+async def launch_volume_explore(
+    *,
+    reader: "IndexReader",
+    title: str,
+    subtitle: str = "",
+    lineage: "list[dict] | None" = None,
+    provenance: "dict | None" = None,
+    can_navigate_parent: bool = False,
+) -> "str | None":
+    """Run the volume explore TUI against an already-open index.
+
+    ``lineage`` is the version chain rendered in the right-pane Lineage
+    box (PRD: walk ``parent`` pointers). Each entry is a dict with at
+    least ``label`` (e.g. ``current`` / ``parent``); optional keys
+    ``name``, ``index_path``, ``total_inodes``, ``used_bytes``, ``error``.
+
+    ``provenance`` carries ``produced_by`` / ``parent_produced_by`` action
+    refs for the Provenance box; ``can_navigate_parent`` enables the "open
+    parent" keybinding.
+
+    Returns the navigation request the user made before exiting — ``"parent"``
+    to re-open explore against the parent version, or ``None`` to stop.
+
+    Async: the :class:`IndexReader` is aiosqlite-backed, so we ``await`` the
+    volume summary up front (``compose`` can't await) and drive the Textual app
+    via ``run_async`` inside the caller's event loop.
+
+    Raises a helpful :class:`ImportError` when ``textual`` is not installed.
+    """
+    try:
+        from flyteplugins.union.cli._tui._volume_explore import VolumeExploreApp, summary_header_text
+    except ImportError as exc:
+        raise ImportError(
+            "The volume explore TUI requires the 'textual' package. "
+            "Install it with:  pip install 'flyteplugins-union[tui]'"
+        ) from exc
+
+    # Precompute the header summary now (async read) so compose() stays sync.
+    summary = await reader.summary()
+    app = VolumeExploreApp(
+        reader=reader,
+        title=title,
+        subtitle=subtitle,
+        root_inode=summary.root_inode,
+        header_text=summary_header_text(summary, subtitle),
+        lineage=lineage or [],
+        provenance=provenance,
+        can_navigate_parent=can_navigate_parent,
+    )
+    await app.run_async()
+    return app.navigate