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

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.8.3
File Size Uploaded
flyteplugins_union-0.8.3.tar.gz 231.6 kB Details

Built distributions (wheels)

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

Total release size: 170.9 MB

Release files / flyteplugins_union-0.8.3.tar.gz

Download URL flyteplugins_union-0.8.3.tar.gz
Size 231.6 kB
Tags Source
SHA-256 checksum
How to use checksums
2f8e255f2990da650621eaee203418617d64f459a23296b3a25fcd4a08cbee69
BLAKE2b-256 checksum
How to use checksums
b4f8839eb173c0fd09316b7f9bc8fad7eb3590335e7ec3c851fade9fec00bd6a
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.8.3-py3-none-win_amd64.whl

Download URL flyteplugins_union-0.8.3-py3-none-win_amd64.whl
Size 34.7 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
b49319e1443cfece71fd9dd858f323a11e96bdc12b25b8ed0043cd5b1075aea1
BLAKE2b-256 checksum
How to use checksums
bd07bd522624ee1ef27653112bbc3933543424ccfe5556f68c387ca282b13ce5
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.8.3-py3-none-manylinux2014_x86_64.whl

Download URL flyteplugins_union-0.8.3-py3-none-manylinux2014_x86_64.whl
Size 34.3 MB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
69f30433423d259f6dee08c27420953ac274bbd016c407bf0377643837b40d14
BLAKE2b-256 checksum
How to use checksums
2ed84ecdb98fa736bfa80ad65b3918bb01f8a667179b03e03e07aa7d178af3e4
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.8.3-py3-none-manylinux2014_aarch64.whl

Download URL flyteplugins_union-0.8.3-py3-none-manylinux2014_aarch64.whl
Size 31.6 MB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
934a961e4e69677e7b9bb72f64631f91733b854221568b69099e6f580cd8444a
BLAKE2b-256 checksum
How to use checksums
ec7a4af7b7e102b84a975ccc01d7bf18007d88682018ee77c135daa48310c95e
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.8.3-py3-none-macosx_11_0_arm64.whl

Download URL flyteplugins_union-0.8.3-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
7454782f3acc46c675d5eee19380a541de56999a2d4faf9200026bf4d9786a00
BLAKE2b-256 checksum
How to use checksums
b83d837389907e9dd41bf44d0cf55848bcc810322a776e57e740b5c83bf99280
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.8.3-py3-none-macosx_10_15_x86_64.whl

Download URL flyteplugins_union-0.8.3-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
4df698d175306d4a5a8e014f01d0dc97dafd7637c3742755e57f6126a9bb88e7
BLAKE2b-256 checksum
How to use checksums
3fdd7e5cb43cf30c0f7dfb7c635a5d79b62fd54e53fa6234a9813294f0e81797
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

0.9.0

6 release files

This release

0.8.3 This release

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