Skip to main content

Union Flyte Plugin

Proprietary extensions and features for Flyte, providing Union-specific functionality.

Installation

uv pip install flyteplugins-union

For development:

uv pip install -e .

Flyte compatibility

flyteplugins-union builds on flyte SDK internals that can change between flyte minor releases, so each release pins flyte to a single minor line. Install a flyteplugins-union release built for your flyte minor:

flyteplugins-union Requires flyte
0.12.0+ >=2.10.0,<2.11.0
0.11.x >=2.6.7,<2.9.0
0.8.2 – 0.10.9 >=2.6.7,<2.7.0
0.8.0 – 0.8.1 >=2.6.3,<2.7.0
0.7.2 >=2.5.20,<2.7.0
0.5.0 – 0.7.1 >=2.5.7,<2.6.0
0.4.3 >=2.5.0,<2.6.0
0.4.0 – 0.4.2 >=2.3.0,<2.5.0
0.3.0 >=2.1.0,<2.5.0

See COMPATIBILITY.md for the rationale and how the pin tracks new flyte releases.

Features

API Key Management

Create and manage API keys for headless authentication with Union.

Create an API Key

flyte create api-key admin --name my-api-key

This will create OAuth application credentials and output an API key that can be used for headless authentication.

Example output:

Client ID: serverless-1-myorg-my-api-key
The following API key will only be shown once. Be sure to keep it safe!
Configure your headless CLI by setting the following environment variable:

export FLYTE_API_KEY="<base64-encoded-credentials>"

Using the API Key

Set the generated API key as an environment variable:

export FLYTE_API_KEY="<your-api-key>"

Then use the Flyte CLI as normal - it will authenticate using the API key instead of prompting for interactive login.

Architecture

The Union SDK is structured as follows:

  • flyteplugins/union/internal/ - Proprietary protobuf definitions and generated code
  • flyteplugins/union/cli/ - CLI command plugins that extend the Flyte CLI
  • flyteplugins/union/utils/ - Shared utility functions
  • flyteplugins/union/remote/ - Union-specific remote objects

Plugin System

The SDK registers CLI plugins via entry points in pyproject.toml:

[project.entry-points."flyte.plugins.cli.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"

This makes Union commands available seamlessly through the Flyte CLI.

Dependencies

  • flyte - The Flyte SDK v2 (pinned to a single minor; see Flyte compatibility)
  • rich-click>=1.8.0 - For CLI formatting

Development

To add a new CLI plugin:

  1. Create a new file in src/flyteplugins/union/cli/
  2. Define your click commands
  3. Register the entry point in pyproject.toml
  4. Shared resources (protobufs, utilities) are available in flyteplugins.union.internal.* and flyteplugins.union.utils.*

Iterating

Commands to rebuild and reinstall this plugin (into the flyte-sdk venv presumably). From this folder:

python -m build --wheel

From your flyte-sdk venv:

uv pip install --prerelease=allow --force-reinstall --no-deps --no-index --find-links /Users/ytong/go/src/github.com/unionai/flyteplugins-union/dist flyteplugins-union

Release files for flyteplugins-union 0.14.0

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Source distribution (sdist)

Source distribution for flyteplugins-union 0.14.0
File Size Uploaded
flyteplugins_union-0.14.0.tar.gz 401.1 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for flyteplugins-union 0.14.0
File
flyteplugins_union-0.14.0-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details
flyteplugins_union-0.14.0-py3-none-manylinux2014_x86_64.whl Python 3 none Linux glibc 2.17+ x86-64 Details
flyteplugins_union-0.14.0-py3-none-manylinux2014_aarch64.whl Python 3 none Linux glibc 2.17+ ARM64 Details
flyteplugins_union-0.14.0-py3-none-macosx_11_0_arm64.whl Python 3 none macOS 11.0+ ARM64 Details
flyteplugins_union-0.14.0-py3-none-macosx_10_15_x86_64.whl Python 3 none macOS 10.15+ x86-64 Details

Total release size: 146.9 MB

Release files / flyteplugins_union-0.14.0.tar.gz

Download URL flyteplugins_union-0.14.0.tar.gz
Size 401.1 kB
Tags Source
SHA-256 checksum
How to use checksums
f30ab7132f2700c1ce756c624e7882d233b36e3b52418691082d4bcce3005c38
BLAKE2b-256 checksum
How to use checksums
356b0ee15ce065a13c76002421247c9d30d561f952b78c48af1026abea262bef
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / flyteplugins_union-0.14.0-py3-none-win_amd64.whl

Download URL flyteplugins_union-0.14.0-py3-none-win_amd64.whl
Size 34.9 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
0719fc23bc69263b3082da5249c2542b169a06f17867bc7d0bae54a5ae6ee5ef
BLAKE2b-256 checksum
How to use checksums
e7b730d83c1894e0ca15f76867fb2e4a01e5149f54c993ed04798a104cae601f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / flyteplugins_union-0.14.0-py3-none-manylinux2014_x86_64.whl

Download URL flyteplugins_union-0.14.0-py3-none-manylinux2014_x86_64.whl
Size 21.8 MB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
38663446bc7c50a30f64838721719f798be33a7b1033aad2b79951cc52a0df2f
BLAKE2b-256 checksum
How to use checksums
aa758b02ed22d5ca07c8c33824794e22dbd1e844760fbd1bfbb7fe9fba59cf6d
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / flyteplugins_union-0.14.0-py3-none-manylinux2014_aarch64.whl

Download URL flyteplugins_union-0.14.0-py3-none-manylinux2014_aarch64.whl
Size 19.4 MB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
9b79359697451b42c56d251ff047079207ba328e897bdbcf6cbc8186f3bbf8fe
BLAKE2b-256 checksum
How to use checksums
a9e891a51f7232b0167fa88e423f448c4110ae243be27ee83289a38e5370ee1b
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / flyteplugins_union-0.14.0-py3-none-macosx_11_0_arm64.whl

Download URL flyteplugins_union-0.14.0-py3-none-macosx_11_0_arm64.whl
Size 34.3 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
669ebb7ccf455443abde44123774a0ccd9cfa4123d6ae041c49619b389a17f53
BLAKE2b-256 checksum
How to use checksums
2eb33e0c59c0a084b69bc3b3ac1fee39904971a23a22852d9bd8c273332439d6
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Release files / flyteplugins_union-0.14.0-py3-none-macosx_10_15_x86_64.whl

Download URL flyteplugins_union-0.14.0-py3-none-macosx_10_15_x86_64.whl
Size 36.2 MB
Tags Python 3 macOS 10.15+ x86-64
SHA-256 checksum
How to use checksums
bb42e05d997c147e3fbb64b102d224039cb593fe518af391a883427e10466499
BLAKE2b-256 checksum
How to use checksums
c91ae431f01da1b4ef353860050ff34209e349e17f7790144a1940fe5168f41c
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/7.0.0 CPython/3.13.14

Release history Release notifications | RSS feed

This release

0.14.0 This release

6 release files

0.13.0

6 release files

0.12.1

6 release files

0.12.0

6 release files

0.11.0

6 release files

0.10.9

6 release files

0.10.8

6 release files

0.10.7

6 release files

0.10.6

6 release files

0.10.5

6 release files

0.10.4

6 release files

0.10.3

6 release files

0.9.0

6 release files

0.8.3

6 release files

0.8.2

6 release files

0.8.1

6 release files

0.8.0

6 release files

0.7.2

6 release files

0.7.1

6 release files

0.7.0

6 release files

0.5.2

6 release files

0.5.1

6 release files

0.5.0

6 release files

0.4.3

6 release files

0.4.2

6 release files

0.4.1

6 release files

0.4.0

6 release files

0.3.0

2 release files

0.2.2

2 release files

0.2.1

2 release files

0.2.0

2 release files

0.1.1

2 release files

0.1.0

2 release files

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page