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.12.1

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.12.1
File Size Uploaded
flyteplugins_union-0.12.1.tar.gz 397.6 kB Details

Built distributions (wheels)

Table of built distributions (wheels) for flyteplugins-union 0.12.1
File
flyteplugins_union-0.12.1-py3-none-win_amd64.whl Python 3 none Windows x86-64 Details
flyteplugins_union-0.12.1-py3-none-manylinux2014_x86_64.whl Python 3 none Linux glibc 2.17+ x86-64 Details
flyteplugins_union-0.12.1-py3-none-manylinux2014_aarch64.whl Python 3 none Linux glibc 2.17+ ARM64 Details
flyteplugins_union-0.12.1-py3-none-macosx_11_0_arm64.whl Python 3 none macOS 11.0+ ARM64 Details
flyteplugins_union-0.12.1-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.12.1.tar.gz

Download URL flyteplugins_union-0.12.1.tar.gz
Size 397.6 kB
Tags Source
SHA-256 checksum
How to use checksums
1d927691da4fe3443a02a2f9f0684ed81850da413d95cf2b1a85a4c878aa642c
BLAKE2b-256 checksum
How to use checksums
781ebd61d95cbbef86b3263053babfd841b762c607af662246feb4ac0dee2b91
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.12.1-py3-none-win_amd64.whl

Download URL flyteplugins_union-0.12.1-py3-none-win_amd64.whl
Size 34.9 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
7ef81668a08daeaea45ded6f33491050d31c83998543a78d867962af21336c5d
BLAKE2b-256 checksum
How to use checksums
55a71f13e40fc9a215ee2657413ba25558e6730fbf51efd179ba2d2a02a6bea2
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.12.1-py3-none-manylinux2014_x86_64.whl

Download URL flyteplugins_union-0.12.1-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
b341c66a566087bfad50816383ef9a019efe2c24e9297fedf342053c52060680
BLAKE2b-256 checksum
How to use checksums
98f1eb7ac2054ac29c2eacfa3876ffa487630d09f0ab1a3e4a282d2bc9c710a0
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.12.1-py3-none-manylinux2014_aarch64.whl

Download URL flyteplugins_union-0.12.1-py3-none-manylinux2014_aarch64.whl
Size 19.4 MB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
f3adfbf5ea9da35c01fde84b69a9811ea2fd3656c36740159ecb3a5e84131419
BLAKE2b-256 checksum
How to use checksums
19f888a0d508f734e3ece7f7cd55d90d3657b04160b1eeb688f6afe32e0a0061
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.12.1-py3-none-macosx_11_0_arm64.whl

Download URL flyteplugins_union-0.12.1-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
8126958be9257fc4b1594cf9a82b630e1036a25a05894ac80ab56a6afb2ad961
BLAKE2b-256 checksum
How to use checksums
ffb97e8835925205f6d641720d21fc9b1333dd10521734bcab14c70ee05d6a08
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.12.1-py3-none-macosx_10_15_x86_64.whl

Download URL flyteplugins_union-0.12.1-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
379e0adaaa19a86cb2d2d1fddd08c8f8a491fb44c5ff22ae93c815d8a9974c3a
BLAKE2b-256 checksum
How to use checksums
c9f30caf373714cd3cb0811bb30326d70e9d42996522c184fe2c813efff4eb75
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.12.1 This release

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