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

Metadata

Release files for flyteplugins-union 0.15.2

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.15.2
File Size Uploaded
flyteplugins_union-0.15.2.tar.gz 449.5 kB Details

Built distributions (wheels)

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

Total release size: 147.5 MB

Release files / flyteplugins_union-0.15.2.tar.gz

Download URL flyteplugins_union-0.15.2.tar.gz
Size 449.5 kB
Tags Source
SHA-256 checksum
How to use checksums
ec8ac5a2666eb87680bb83ff013126c25f847535eb492044e8f7fd651a78ba7c
BLAKE2b-256 checksum
How to use checksums
167d8b940b49ffb3a152e0b8e5dcbefeb7f2be50997e6d7e0eb88235d991ef0a
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.15.2-py3-none-win_amd64.whl

Download URL flyteplugins_union-0.15.2-py3-none-win_amd64.whl
Size 35.0 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
f0108875c38c8f93a28674775a9ef6a03b2e5ffa13e471c13f97b9aa0855197b
BLAKE2b-256 checksum
How to use checksums
a287db4eea67337cc1069be887c2ac7e1003f78bffb06f8d699c12ce0dd038da
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.15.2-py3-none-manylinux2014_x86_64.whl

Download URL flyteplugins_union-0.15.2-py3-none-manylinux2014_x86_64.whl
Size 22.0 MB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
2a598027d44a60989d0f51c70af809287000f1aeb49063196baa108ca0d4152d
BLAKE2b-256 checksum
How to use checksums
1f991294a0fa82e285a7c26a23c7ecbd0a0bec7a465a9ef75b9d5789b42826b4
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.15.2-py3-none-manylinux2014_aarch64.whl

Download URL flyteplugins_union-0.15.2-py3-none-manylinux2014_aarch64.whl
Size 19.5 MB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
cda6ecc55f2ab0854c230f2de9a29fed323b2a2df6b49e9f513a3663b59b3f5a
BLAKE2b-256 checksum
How to use checksums
5294bc85858505cfebac75c95f89ccba07d3e8d234810ffc2c00570cc7db4e7b
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.15.2-py3-none-macosx_11_0_arm64.whl

Download URL flyteplugins_union-0.15.2-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
c149c76d67facd944903121f6c4b17512737e8f5d7e9e2f46d7d8a69415c9138
BLAKE2b-256 checksum
How to use checksums
8863300293621e855e876fe9f649bee1937af525a493c048bb3bee5b050af976
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.15.2-py3-none-macosx_10_15_x86_64.whl

Download URL flyteplugins_union-0.15.2-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
87fc268ffdbb89a07e4b9d722f9cf61a27ff064065993cb8cfbe90088e8a1c9a
BLAKE2b-256 checksum
How to use checksums
a3a16301842714e0f6458c8f78e7313667512ae0b056b74515b773e4f3ee5262
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.15.2 This release

6 release files

0.15.0

6 release files

0.14.1

6 release files

0.14.0

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