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

Metadata

Release files for flyteplugins-union 0.17.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.17.0
File Size Uploaded
flyteplugins_union-0.17.0.tar.gz 473.2 kB Details

Built distributions (wheels)

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

Total release size: 121.1 MB

Release files / flyteplugins_union-0.17.0.tar.gz

Download URL flyteplugins_union-0.17.0.tar.gz
Size 473.2 kB
Tags Source
SHA-256 checksum
How to use checksums
e12f3edc466531dd1a9e0166a82bc52ad6e9a220ba6644fce95c76ea07b6e6b2
BLAKE2b-256 checksum
How to use checksums
475c7aedb05fa35d5ad06fe706522849cda973f0d35e88cbdb7b0335d669b4f7
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.17.0-py3-none-win_amd64.whl

Download URL flyteplugins_union-0.17.0-py3-none-win_amd64.whl
Size 35.0 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
ae8ba669565869e178b896887cca1d777025416498cb0b7143c077125419a601
BLAKE2b-256 checksum
How to use checksums
396f1ec113b26317679468ca80e9996b91debb737b6ad54ae46151620181b1cb
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.17.0-py3-none-manylinux2014_x86_64.whl

Download URL flyteplugins_union-0.17.0-py3-none-manylinux2014_x86_64.whl
Size 22.5 MB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
e77ada65779189960102fc9d213902b2b15022779622b46db857ca27a2c61d80
BLAKE2b-256 checksum
How to use checksums
d885527444b3d2d8f50d6a1474cf242b2b353c51d18872077f885fca8735da13
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.17.0-py3-none-manylinux2014_aarch64.whl

Download URL flyteplugins_union-0.17.0-py3-none-manylinux2014_aarch64.whl
Size 20.0 MB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
86fd2b5f97ba4f7524008b5e5fa50c3cec1a4f962a3d6c4a9e6ed91ab1c6cc7f
BLAKE2b-256 checksum
How to use checksums
761c7e988939ddfc117868f2211ff9ff678f6d082ee9b1fe68e1dd375735fef4
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.17.0-py3-none-macosx_11_0_arm64.whl

Download URL flyteplugins_union-0.17.0-py3-none-macosx_11_0_arm64.whl
Size 20.5 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
681fa72a13484879502b4b18c9264b0e23edfedfc00a4bebae34539e1adc2f4c
BLAKE2b-256 checksum
How to use checksums
359a5424d112c88bd232997bc5b42919d184feb433b71f9004ab5c88c2c76937
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.17.0-py3-none-macosx_10_15_x86_64.whl

Download URL flyteplugins_union-0.17.0-py3-none-macosx_10_15_x86_64.whl
Size 22.6 MB
Tags Python 3 macOS 10.15+ x86-64
SHA-256 checksum
How to use checksums
6134bbae678c79e496f1dc21053b51c5b345ec403a7df854eef7fe83ec24494b
BLAKE2b-256 checksum
How to use checksums
f5677bdde58adee8ad5d1265332107420aafe3a44c73cb062734a434c7d846be
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.17.0 This release

6 release files

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

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