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.15.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.15.0
File Size Uploaded
flyteplugins_union-0.15.0.tar.gz 448.2 kB Details

Built distributions (wheels)

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

Total release size: 147.4 MB

Release files / flyteplugins_union-0.15.0.tar.gz

Download URL flyteplugins_union-0.15.0.tar.gz
Size 448.2 kB
Tags Source
SHA-256 checksum
How to use checksums
2c75454436c9c6421f73a80e62ad7cd4b3130787aca829b923ee63ff31ac8ed3
BLAKE2b-256 checksum
How to use checksums
2ba16d11c1719d2555ecf80c35852e1db3907b5e48129fa27ba8ca1b04b56257
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.0-py3-none-win_amd64.whl

Download URL flyteplugins_union-0.15.0-py3-none-win_amd64.whl
Size 35.0 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
89ace9f2d60df9e96ba1512dd00131ac46bd218fe81fb22e6392ddb163a60ebc
BLAKE2b-256 checksum
How to use checksums
058c3c92adc1998cdac1ce6a2e5caf43c76e6d377dfb6ae3ad518163583af7d9
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.0-py3-none-manylinux2014_x86_64.whl

Download URL flyteplugins_union-0.15.0-py3-none-manylinux2014_x86_64.whl
Size 21.9 MB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
5fb0a478f1ed2008d412fb2ec0785d00d46496a6806fa6de5a49a531ccae59f2
BLAKE2b-256 checksum
How to use checksums
0b4ce18ba8fc8c9ee6fea3dc9486ee4b06cc25affc635bb7d5302c5a3b4a9a39
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.0-py3-none-manylinux2014_aarch64.whl

Download URL flyteplugins_union-0.15.0-py3-none-manylinux2014_aarch64.whl
Size 19.5 MB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
ca61ab117dcceaed85c8d8b1996be0fd471e3d034f91b0d2a51a61d3acc1fb2b
BLAKE2b-256 checksum
How to use checksums
19350e68d92f902d18c071631f6ff155ac808f013250dcecd3bcd46fc0a5965b
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.0-py3-none-macosx_11_0_arm64.whl

Download URL flyteplugins_union-0.15.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
d8d3bd00ef4dcb4570eeaf5bfbbaf47293651b39ea6d4fbe286c6468f62e33c1
BLAKE2b-256 checksum
How to use checksums
34b8f7dc0b70fd4317d9f8b9902c26d76ad12e4415ba1ff705a078ece17ea02c
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.0-py3-none-macosx_10_15_x86_64.whl

Download URL flyteplugins_union-0.15.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
9c69f0ac03e2e4dddb6f8eab8c21c2a49f70c31fa87ac1cf5006c96cca9c5fc9
BLAKE2b-256 checksum
How to use checksums
21cbbab6816ec86c55a725e9d97e84307c3573ce1b82b1b9b6898103c3be8c87
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.0 This release

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