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.10.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.10.1
File Size Uploaded
flyteplugins_union-0.10.1.tar.gz 300.1 kB Details

Built distributions (wheels)

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

Total release size: 146.1 MB

Release files / flyteplugins_union-0.10.1.tar.gz

Download URL flyteplugins_union-0.10.1.tar.gz
Size 300.1 kB
Tags Source
SHA-256 checksum
How to use checksums
4b54af7d2ad19dcdcf03557741bcebcb2e018cd3b0a6564b43763bd56dc75dc6
BLAKE2b-256 checksum
How to use checksums
13f70845f6cfdda436ba113a3bc663547a773359692c07b7d6302e0e49f3a53c
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.10.1-py3-none-win_amd64.whl

Download URL flyteplugins_union-0.10.1-py3-none-win_amd64.whl
Size 34.8 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
f2b94ec3a4e346ad27b14f5e2159256fb2500cb245aaccd90e173bd483d9fa0d
BLAKE2b-256 checksum
How to use checksums
13fabba087a235bdcf629057daf4eaf87b01150d255b09f43e0496695eafba13
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.10.1-py3-none-manylinux2014_x86_64.whl

Download URL flyteplugins_union-0.10.1-py3-none-manylinux2014_x86_64.whl
Size 21.6 MB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
8f41e8c6aff260c3f2eece777856342cdfae535cf90cf553a9d77f60826e74b2
BLAKE2b-256 checksum
How to use checksums
d72f597dd9337ccae8694d5b95f4489ca41158ab5cdaecc6229a0edc05ea3016
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.10.1-py3-none-manylinux2014_aarch64.whl

Download URL flyteplugins_union-0.10.1-py3-none-manylinux2014_aarch64.whl
Size 19.2 MB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
62da00abe7cad64ad54592ab76b8fe0bc91c4430e92d8e59f7ca9876daed77bb
BLAKE2b-256 checksum
How to use checksums
34fb3458b0d1d38af9eebd23e616293b1fbdf34f9d9a5f3e788ac0c07e935c40
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.10.1-py3-none-macosx_11_0_arm64.whl

Download URL flyteplugins_union-0.10.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
1cbaf7baff375d5ac26dc64760e08683f86dde95438fe846179047d4a9e855cc
BLAKE2b-256 checksum
How to use checksums
34088b8ed8c1db6ef1d922c63cfcae344b2f29b4441e22584f559630f3b8cee3
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.10.1-py3-none-macosx_10_15_x86_64.whl

Download URL flyteplugins_union-0.10.1-py3-none-macosx_10_15_x86_64.whl
Size 36.1 MB
Tags Python 3 macOS 10.15+ x86-64
SHA-256 checksum
How to use checksums
1d8d7d818745e052adbc116aae95435aac85f6ff3557a990e749393cc0294e33
BLAKE2b-256 checksum
How to use checksums
11c25d00e2295e7febaa0c561ddae83b8aac0fb45d26b786e113d12673f6a497
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

This release

0.10.1 This release

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