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 codeflyteplugins/union/cli/- CLI command plugins that extend the Flyte CLIflyteplugins/union/utils/- Shared utility functionsflyteplugins/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:
- Create a new file in
src/flyteplugins/union/cli/ - Define your click commands
- Register the entry point in
pyproject.toml - Shared resources (protobufs, utilities) are available in
flyteplugins.union.internal.*andflyteplugins.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
2 maintainers
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distributions
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file flyteplugins_union-0.10.5.tar.gz.
File metadata
- Download URL: flyteplugins_union-0.10.5.tar.gz
- Upload date:
- Size: 316.7 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
de891b2fd8cebc30608a54b3a71b5821cb9b0e46c152cd1856aa30b97b43e5f1
|
|
| MD5 |
fc37ddef9eda0e132ad2d2e3052bac66
|
|
| BLAKE2b-256 |
d64b9fcdf9dc3556e26f2fbc7ab3a69b7360c56c68ac647f8aa4a2de01296c33
|
File details
Details for the file flyteplugins_union-0.10.5-py3-none-win_amd64.whl.
File metadata
- Download URL: flyteplugins_union-0.10.5-py3-none-win_amd64.whl
- Upload date:
- Size: 34.8 MB
- Tags: Python 3, Windows x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
040e3b7c232958ae7ab34547350cbb80374b78c4d5893b5d9a67d88f20ec6d49
|
|
| MD5 |
e8a13d84f51376a252258664d47f7477
|
|
| BLAKE2b-256 |
a731eda127e3630e998c17fc9651cd03a2ada8ffde61760d6167ea6d2b3428ce
|
File details
Details for the file flyteplugins_union-0.10.5-py3-none-manylinux2014_x86_64.whl.
File metadata
- Download URL: flyteplugins_union-0.10.5-py3-none-manylinux2014_x86_64.whl
- Upload date:
- Size: 21.6 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f2d7225fc2459ffdd03670e57489048927d7ae30971631d7a5d22ca9deb2c392
|
|
| MD5 |
5255717d98e14e6ad1bdd243687c3022
|
|
| BLAKE2b-256 |
1a25a65e25dcf956236ecc9e85ec777c6c2d00cb83dd7ead46e864e24547f7bd
|
File details
Details for the file flyteplugins_union-0.10.5-py3-none-manylinux2014_aarch64.whl.
File metadata
- Download URL: flyteplugins_union-0.10.5-py3-none-manylinux2014_aarch64.whl
- Upload date:
- Size: 19.2 MB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f2cdf592d8e7552e54aee99d6e5b1f5af0f71588a1c5d9654c6d58f652052e9c
|
|
| MD5 |
7464e7534a3b88815bdd4214a49f2a4f
|
|
| BLAKE2b-256 |
02e702baf96636185af82670add70b60fc669baa4288b1ee9ace045bc141892f
|
File details
Details for the file flyteplugins_union-0.10.5-py3-none-macosx_11_0_arm64.whl.
File metadata
- Download URL: flyteplugins_union-0.10.5-py3-none-macosx_11_0_arm64.whl
- Upload date:
- Size: 34.2 MB
- Tags: Python 3, macOS 11.0+ ARM64
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
f4147b15a77afc3031115c2c4e8fa64904b65d42658612e512c6c83927dde3ac
|
|
| MD5 |
54dce06caea4da1f5f471475fc31061b
|
|
| BLAKE2b-256 |
3748e161f11e50b637afea73bbb6f04fed0c44a63b61ea9a26030bbc2fee0e9d
|
File details
Details for the file flyteplugins_union-0.10.5-py3-none-macosx_10_15_x86_64.whl.
File metadata
- Download URL: flyteplugins_union-0.10.5-py3-none-macosx_10_15_x86_64.whl
- Upload date:
- Size: 36.1 MB
- Tags: Python 3, macOS 10.15+ x86-64
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/7.0.0 CPython/3.13.14
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
a194823427515e2752b193f804539f2ae71fbc7dfa45b313cf8298cd02faf5cf
|
|
| MD5 |
da64ead2858ffd819c4dcea35ff7b9fd
|
|
| BLAKE2b-256 |
1717c1564905cfbb446bc0a901110cdf7371e3cf33e5ae5911c83816f23d9fbf
|
