---
id: flyteidl2
version: "2.0.41"
license: unclear
license_treatment: permissive
maintenance: active
---

# flyteidl2 — IDL for Flyte

License: permissive · Maintenance: active · Downloads: 180.3K/mo

## What it is and what it does

flyteidl2 is a Python library that bundles the protobuf message definitions and serialization code for Flyte's interface definition language. It serves as the contract layer between Flyte workflow components, allowing them to communicate using well-defined, versioned message schemas. The package is built from protobuf definitions and depends on standard protobuf tooling (protobuf, googleapis-common-protos, protoc-gen-openapiv2, protovalidate) to provide runtime message handling.

This is a foundational library for anyone building or integrating with Flyte workflows. It is not a standalone application but rather a dependency that Flyte clients, plugins, and the Flyte control plane use to serialize and deserialize workflow metadata, task definitions, and execution state. If you are working directly with Flyte, you will likely install this as a transitive dependency rather than explicitly.

Use it for:

- Building Flyte task plugins or custom workflow components that need to serialize task metadata and execution state.
- Integrating external systems with Flyte by consuming or producing Flyte workflow definitions and execution events.
- Developing Flyte control-plane extensions that operate on workflow and task protobuf messages.
- Debugging Flyte workflows by inspecting serialized protobuf messages in logs or event streams.

## Worth the install?

AI-flagged interpretation of the facts above — verify before relying.

Provides Python protobuf message definitions and serialization support for Flyte's interface definition language (IDL), enabling communication between Flyte workflow components.

Yes, if you are developing for or integrating with Flyte. This is a foundational library that Flyte itself depends on; you will almost certainly need it as a transitive dependency. Install it explicitly only if you are building Flyte plugins or custom integrations that directly consume its protobuf definitions. The package is actively maintained, has no known vulnerabilities, and carries a permissive Apache 2.0 license.

## Install

pip install flyteidl2
uv add flyteidl2
poetry add flyteidl2

## Installing flyteidl2

Before you install: Active maintenance with a recent release. Low install friction from a pure-Python wheel with four runtime dependencies (protobuf, googleapis-common-protos, protoc-gen-openapiv2, protovalidate), all standard protocol-buffer tooling.

License in practice: Licensed under Apache License 2.0 (permissive), allowing use in most commercial and open-source projects without significant restriction.

Quickstart:

pip install flyteidl2

from flyteidl2 import core
# Use protobuf message definitions from flyteidl2.core or other submodules

Requires Python 3.10 or later; protobuf runtime dependencies must be installed alongside.

Verify before relying:

- Whether this package is intended for end-user workflow development or primarily for Flyte framework internals.
- What specific protobuf message types and services are exposed and their typical usage patterns.
- Whether documentation or examples exist beyond the package metadata.

## Package facts

- License: not declared (permissive)
- Python support: supports_current
- Install friction: low
- Maintenance: active
- Downloads: 180.3K/month (top 15,000 on PyPI)
- Known vulnerabilities: none known

## Tags

flyte protobuf definitions, flyte IDL python library, flyte message serialization, flyte workflow protocol buffers, flyte component communication, protobuf IDL for flyte, flyte data model definitions, protobuf, flyte-ecosystem, workflow-orchestration

[View on SkillFed](https://skillfed.io/packages/flyteidl2) · [View on PyPI](https://pypi.org/project/flyteidl2/)