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.0+ >=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.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.8.1
File Size Uploaded
flyteplugins_union-0.8.1.tar.gz 229.8 kB Details

Built distributions (wheels)

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

Download URL flyteplugins_union-0.8.1.tar.gz
Size 229.8 kB
Tags Source
SHA-256 checksum
How to use checksums
510af2fbec70ce77d585b753e80a4784f07094bae8fb6741cd3d49fdbf254a19
BLAKE2b-256 checksum
How to use checksums
c60054f870f362e82e5caa9346f0d3f75ad2cb72b2d092dfffb802d02fac42e8
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.1-py3-none-win_amd64.whl

Download URL flyteplugins_union-0.8.1-py3-none-win_amd64.whl
Size 34.7 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
72f56e686fae278ebab51b72ff4878d75cb23872fd4f11e2e210e3aa12ca557f
BLAKE2b-256 checksum
How to use checksums
1587edad03b6a146978ff4e838ec26d4216ff0b2ce1db741773e550803caa53d
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.1-py3-none-manylinux2014_x86_64.whl

Download URL flyteplugins_union-0.8.1-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
468be5b6140305329cec1bc9da2eed76cfc70b6848e6e03e51a63a417a4265c3
BLAKE2b-256 checksum
How to use checksums
2c9eb6e71c5a38c50160f83d0292a57048f9da6744f1156fe12dab07d303106c
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.1-py3-none-manylinux2014_aarch64.whl

Download URL flyteplugins_union-0.8.1-py3-none-manylinux2014_aarch64.whl
Size 31.6 MB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
4c17bd29df73b64b5e4dd120d82e431ce9fed120a956b0f27f3994c0833ac5ec
BLAKE2b-256 checksum
How to use checksums
0a7ab87a78dde2577d76dc775e19268535772955bcc0f78d44737344693643f7
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.1-py3-none-macosx_11_0_arm64.whl

Download URL flyteplugins_union-0.8.1-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
3022793b9a02ac9b70066e983bec7a4530884c1f1502eadccb5b58fb3da50476
BLAKE2b-256 checksum
How to use checksums
69b0d1fcaafdf473ca9e44618fe43e01514bd991f16998551d5638bf7e841846
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.1-py3-none-macosx_10_15_x86_64.whl

Download URL flyteplugins_union-0.8.1-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
a011e3aa6bc26812da7ce1afb330174f0606f59dbbc9c4c4785b8efdeb54e898
BLAKE2b-256 checksum
How to use checksums
730534ae255ea07aadc738641a5af6bfe45ed7ac5456b025622b0bbcf9bbfee1
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.16.0

6 release files

0.15.5

1 release file

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

This release

0.8.1 This release

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