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.5.0+ >=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.5.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.5.0
File Size Uploaded
flyteplugins_union-0.5.0.tar.gz 187.5 kB Details

Built distributions (wheels)

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

Total release size: 170.6 MB

Release files / flyteplugins_union-0.5.0.tar.gz

Download URL flyteplugins_union-0.5.0.tar.gz
Size 187.5 kB
Tags Source
SHA-256 checksum
How to use checksums
4f29b295c1485bd8c339800aa175493b667f585583d6ac1abccb348b36aacdce
BLAKE2b-256 checksum
How to use checksums
c3bfc28d0d4482e24fd8384c2db9f00304e1378a409189460bd6f5b2e3dcd830
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Release files / flyteplugins_union-0.5.0-py3-none-win_amd64.whl

Download URL flyteplugins_union-0.5.0-py3-none-win_amd64.whl
Size 34.7 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
a8119d1ea13c3dae30e43b88caa68e292a157d32e205b83c4759c8b5a9dd54f7
BLAKE2b-256 checksum
How to use checksums
3d56de311cca1b03ee5ed4aa91cda459791894a1de070247d83f48cbc806e59a
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Release files / flyteplugins_union-0.5.0-py3-none-manylinux2014_x86_64.whl

Download URL flyteplugins_union-0.5.0-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
83fd2f58118801673a7af00f92e7f433f71d431544218872e536bca4e2021c0c
BLAKE2b-256 checksum
How to use checksums
23779d3603777950198c1e08cd674a61dd5f01f502fbe873a4499abe502e0faa
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Release files / flyteplugins_union-0.5.0-py3-none-manylinux2014_aarch64.whl

Download URL flyteplugins_union-0.5.0-py3-none-manylinux2014_aarch64.whl
Size 31.5 MB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
9c854545e4334b093c46f72c61f85c277ed85aa94aee77a3b06a9212a078f377
BLAKE2b-256 checksum
How to use checksums
f2ea794a719a9aad965b8fcb92df60ade1470be798f34884ec8194b9bf70558f
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Release files / flyteplugins_union-0.5.0-py3-none-macosx_11_0_arm64.whl

Download URL flyteplugins_union-0.5.0-py3-none-macosx_11_0_arm64.whl
Size 34.0 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
f09728781515d2d154051df9b2410ade13959afefc58ae43a7a663f676fb23dd
BLAKE2b-256 checksum
How to use checksums
709f99661f731ec67998fc2a5ead85f9e43524ab75b4eef92564dfa1f707a8d4
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Release files / flyteplugins_union-0.5.0-py3-none-macosx_10_15_x86_64.whl

Download URL flyteplugins_union-0.5.0-py3-none-macosx_10_15_x86_64.whl
Size 35.9 MB
Tags Python 3 macOS 10.15+ x86-64
SHA-256 checksum
How to use checksums
57fb62bd35db9a7e3cec08b6a1e502a2554b62c427d3c5f3fa219f8f26b3fe30
BLAKE2b-256 checksum
How to use checksums
a7806b07736172ebc0218eb36c547fc5d6074448da592246644de2878e84a621
Upload date
Uploaded using Trusted Publishing?
What is trusted publishing?
Yes
Uploaded via twine/6.1.0 CPython/3.13.12

Release history Release notifications | RSS feed

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

This release

0.5.0 This release

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