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.8.2+ >=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.9.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.9.0
File Size Uploaded
flyteplugins_union-0.9.0.tar.gz 272.6 kB Details

Built distributions (wheels)

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

Total release size: 171.3 MB

Release files / flyteplugins_union-0.9.0.tar.gz

Download URL flyteplugins_union-0.9.0.tar.gz
Size 272.6 kB
Tags Source
SHA-256 checksum
How to use checksums
135eac85a78e25ea991ef9c3d2b21666ad94b0d5edb6a6df62ae62a49052f464
BLAKE2b-256 checksum
How to use checksums
db89c4ff0a21b8499c073f4312f040da2f730328746b877cd92cda3bc69334b3
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.9.0-py3-none-win_amd64.whl

Download URL flyteplugins_union-0.9.0-py3-none-win_amd64.whl
Size 34.8 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
074d99310764afc867447b3a010a1e3879e4618f34fb883d9670bea4a5102f46
BLAKE2b-256 checksum
How to use checksums
d68c5f05dedc40899b78a8063f651f2560f5f4d1f42efd0013060fbdf35c483d
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.9.0-py3-none-manylinux2014_x86_64.whl

Download URL flyteplugins_union-0.9.0-py3-none-manylinux2014_x86_64.whl
Size 34.4 MB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
dd78dbdadde7f67b23633950dc5d1dec4e88eacaaa1d3b608b030c1154209de8
BLAKE2b-256 checksum
How to use checksums
eec072eb9bff84cf830b43691eb4433cbb98c6e5a7af5226d898c10ff1f7270c
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.9.0-py3-none-manylinux2014_aarch64.whl

Download URL flyteplugins_union-0.9.0-py3-none-manylinux2014_aarch64.whl
Size 31.7 MB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
b91041ed4652a6c26bda1a3a9b21770215f618562f7595242104b162b593e2d7
BLAKE2b-256 checksum
How to use checksums
e133796de22465b445c018246855267e4c03f36488086926d55b366bcacc0c41
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.9.0-py3-none-macosx_11_0_arm64.whl

Download URL flyteplugins_union-0.9.0-py3-none-macosx_11_0_arm64.whl
Size 34.1 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
0636a03f6049588511a1f3bcb413384e9985391d3ed16776b6534c254048e540
BLAKE2b-256 checksum
How to use checksums
00ac2f0202519411f6fa563019aebe6a216d7c9aa97d0d4f2e3826a0e73e0286
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.9.0-py3-none-macosx_10_15_x86_64.whl

Download URL flyteplugins_union-0.9.0-py3-none-macosx_10_15_x86_64.whl
Size 36.0 MB
Tags Python 3 macOS 10.15+ x86-64
SHA-256 checksum
How to use checksums
34897ca2693f7488f361c08061cd748051be3b357a7a913ada70aec3a49fc877
BLAKE2b-256 checksum
How to use checksums
f05c6bd421bccce9ac864114d8d3188d44878bed4c6a2dd70eae74ce1ae2e4be
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

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

This release

0.9.0 This release

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