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.15.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.15.1
File Size Uploaded
flyteplugins_union-0.15.1.tar.gz 448.9 kB Details

Built distributions (wheels)

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

Total release size: 147.4 MB

Release files / flyteplugins_union-0.15.1.tar.gz

Download URL flyteplugins_union-0.15.1.tar.gz
Size 448.9 kB
Tags Source
SHA-256 checksum
How to use checksums
de63ec094c18dd20da96034ffb4027d984323e50d09a62f6e2d38a1e15eb092e
BLAKE2b-256 checksum
How to use checksums
c4f82ba7fdb5d33a0fd57a1c0b93c4458c1336aa3fd4b170bd4295d7d83b7d12
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.15.1-py3-none-win_amd64.whl

Download URL flyteplugins_union-0.15.1-py3-none-win_amd64.whl
Size 35.0 MB
Tags Python 3 Windows x86-64
SHA-256 checksum
How to use checksums
00e33e948e41657306710c6ea34365228ffefe49ffe137a22a3e2d6d391487ed
BLAKE2b-256 checksum
How to use checksums
219e89dfd4d84ff459878bc458ca5889376e25c95c54f045c64ba7a4f99c85d3
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.15.1-py3-none-manylinux2014_x86_64.whl

Download URL flyteplugins_union-0.15.1-py3-none-manylinux2014_x86_64.whl
Size 22.0 MB
Tags Linux glibc 2.17+ x86-64 Python 3
SHA-256 checksum
How to use checksums
00737b38d1324cf2c50280580594836e07c3701d423c0558c57ff1517e421883
BLAKE2b-256 checksum
How to use checksums
c38a30bba9718502c5c1bbb774eb7a7f5ee92802e46d2f90e7b8105d1f19ed8c
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.15.1-py3-none-manylinux2014_aarch64.whl

Download URL flyteplugins_union-0.15.1-py3-none-manylinux2014_aarch64.whl
Size 19.5 MB
Tags Linux glibc 2.17+ ARM64 Python 3
SHA-256 checksum
How to use checksums
059d82e9afe38e9e2705ac4b7c553714844b1270e00cc0ba453c6ea4d9b19477
BLAKE2b-256 checksum
How to use checksums
012f784e59d12db14c0565cf5827763f1e5aed10c57206134fc487ac49c175cf
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.15.1-py3-none-macosx_11_0_arm64.whl

Download URL flyteplugins_union-0.15.1-py3-none-macosx_11_0_arm64.whl
Size 34.3 MB
Tags Python 3 macOS 11.0+ ARM64
SHA-256 checksum
How to use checksums
b364f5ab617502217686cac0ced5a1d174ea4786a919540948efb3224a373e9c
BLAKE2b-256 checksum
How to use checksums
439b3b11dc4a3823463c4a739b5616c2138bb6238618273e20ed69be7e55cb78
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.15.1-py3-none-macosx_10_15_x86_64.whl

Download URL flyteplugins_union-0.15.1-py3-none-macosx_10_15_x86_64.whl
Size 36.2 MB
Tags Python 3 macOS 10.15+ x86-64
SHA-256 checksum
How to use checksums
c34acf0e688f21cfabc9afdd437462ce21d02333ea238d191b16d6dbfaa5a54a
BLAKE2b-256 checksum
How to use checksums
f01d6bc3b90372b2b8e8768d5e1f9fd3670c140627bcdacd6f47f7670fef3f8b
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.15.1 This release

6 release files

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