api-packages.toml

# API documentation package registry
#
# Lists all packages whose API docs we generate.
# Used by tools throughout the build pipeline.
#
# Sections:
#   [[sdks]]          - SDK packages (one per entry, v2 has 1, v1 has 2)
#   [[clis]]          - CLI documentation entries
#   [plugins_config]  - Shared plugin settings (output_base, default_include)
#   [[plugins]]       - Plugin packages
#
# Fields for [[sdks]]:
#   package          - PyPI package name
#   install          - (optional) pip install specifier (defaults to package)
#   parser_package   - Python import path for the API parser
#   generator_name   - Name argument for the API generator
#   generator_title  - Title argument for the API generator
#   include          - Path to the header template file
#   output_folder    - Output directory for generated docs
#   version_file     - File containing version in frontmatter
#   weight           - (optional) Hugo menu weight
#   expanded         - (optional) Hugo menu expanded setting
#   no_flatten       - (optional) Generator no-flatten flag
#   variants         - (optional) Variant flags for the generator
#
# Fields for [[clis]]:
#   name             - CLI identifier
#   package          - (optional) PyPI package providing the CLI
#   import           - (optional) Python import for version detection
#   include          - Path to the header template file
#   output_file      - Output file path for single-file CLI docs (use one of output_file or output_dir)
#   output_dir       - Output directory for multi-file CLI docs (use one of output_file or output_dir)
#   gen_command      - (optional) Command to generate CLI docs (Python CLIs)
#   type             - (optional) "go" for Go-based CLIs (externally produced)
#   binary           - (optional) Binary name for Go CLIs
#   frozen           - (optional) If true, skip clean/generate (committed content, no longer regenerable)
#
# Fields for [plugins_config]:
#   output_base      - Base directory for plugin output (e.g., integrations or plugins)
#   default_include  - Default header template for plugins
#   no_flatten       - If true, generate hierarchical output (separate class files)
#
# Fields for [[plugins]]:
#   package  - PyPI package name (for version checks and pip install)
#   plugin   - Python import path (for the API parser)
#   title    - Display title for the documentation
#   name     - Folder name under output_base
#   extras   - (optional) pip extras to install, e.g. ["bigquery", "snowflake"]
#   frozen   - (optional) If true, skip clean/generate (committed content, no longer regenerable)

# === SDK packages ===

[[sdks]]
package = "flyte"
install = "flyte[connector,aiosqlite,tui]"
parser_package = "flyte"
generator_name = "flytesdk"
generator_title = "Flyte SDK"
include = "include/api.flyte-sdk.md"
output_folder = "content/api-reference/flyte-sdk"
version_file = "content/api-reference/flyte-sdk/_index.md"
weight = 4
no_flatten = true
variants = "+flyte +union"

# === CLIs ===

[[clis]]
name = "flyte"
package = "flyte"
import = "flyte"
include = "include/cli.flyte.md"
output_file = "content/api-reference/flyte-cli.md"
gen_command = "flyte gen docs --type markdown --plugin-variants 'union'"

[[clis]]
name = "uctl"
type = "go"
binary = "uctl"
include = "include/cli.uctl.md"
output_dir = "content/api-reference/uctl-cli"
frozen = true

# === Plugins ===

[plugins_config]
output_base = "content/api-reference/integrations"
default_include = "include/api.plugin.md"
no_flatten = true  # v2: hierarchical output (separate class files per package)

# Agent framework adapters. One package per framework on a shared core, all
# documented as a group under content/integrations/agents/, so their API reference
# is nested to match rather than adding eleven siblings at the top of output_base.
# `name` stays flat (agents-<framework>) because it names the linkmap file, which
# lives in a single flat directory; page URLs follow output_folder, not name.
[[plugins]]
package = "flyteplugins-agents-core"
plugin = "flyteplugins.agents.core"
title = "Core"
name = "agents-core"
output_folder = "content/api-reference/integrations/agents/core"

[[plugins]]
package = "flyteplugins-agents-claude"
plugin = "flyteplugins.agents.claude"
title = "Claude Agent SDK"
name = "agents-claude"
output_folder = "content/api-reference/integrations/agents/claude"

[[plugins]]
package = "flyteplugins-agents-crewai"
plugin = "flyteplugins.agents.crewai"
title = "CrewAI"
name = "agents-crewai"
output_folder = "content/api-reference/integrations/agents/crewai"

[[plugins]]
package = "flyteplugins-agents-deepagents"
plugin = "flyteplugins.agents.deepagents"
title = "Deep Agents"
name = "agents-deepagents"
output_folder = "content/api-reference/integrations/agents/deepagents"

[[plugins]]
package = "flyteplugins-agents-google"
plugin = "flyteplugins.agents.google"
title = "Google ADK"
name = "agents-google"
output_folder = "content/api-reference/integrations/agents/google"

[[plugins]]
package = "flyteplugins-agents-hermes"
plugin = "flyteplugins.agents.hermes"
title = "Hermes"
name = "agents-hermes"
output_folder = "content/api-reference/integrations/agents/hermes"

[[plugins]]
package = "flyteplugins-agents-langchain"
plugin = "flyteplugins.agents.langchain"
title = "LangChain"
name = "agents-langchain"
output_folder = "content/api-reference/integrations/agents/langchain"

[[plugins]]
package = "flyteplugins-agents-langgraph"
plugin = "flyteplugins.agents.langgraph"
title = "LangGraph"
name = "agents-langgraph"
output_folder = "content/api-reference/integrations/agents/langgraph"

[[plugins]]
package = "flyteplugins-agents-mistral"
plugin = "flyteplugins.agents.mistral"
title = "Mistral"
name = "agents-mistral"
output_folder = "content/api-reference/integrations/agents/mistral"

[[plugins]]
package = "flyteplugins-agents-openai"
plugin = "flyteplugins.agents.openai"
title = "OpenAI Agents SDK"
name = "agents-openai"
output_folder = "content/api-reference/integrations/agents/openai"

# Pinned to 2.5.18 (DOC-1404). 2.5.19 is the only flyteplugins-* 2.5.19 that was
# NOT yanked, so the resolver picks it -- but it imports `apply_instrumentation`
# from flyteplugins-agents-core, whose 2.5.19 WAS yanked, so the resolver pairs it
# with agents-core 2.5.18, which lacks that symbol. The import fails, the parser
# only warns, and the generator then writes an 11-line stub with no API content
# while make still exits 0. `make dist` reproduces this on every build.
#
# The pin restores the working pair. The advisory PyPI-drift check will keep
# reporting this plugin as behind; that is correct and deliberate. Remove the pin
# once a release ships in which agents-pydantic-ai and agents-core are installable
# together.
[[plugins]]
package = "flyteplugins-agents-pydantic-ai"
install = "flyteplugins-agents-pydantic-ai==2.5.18"
plugin = "flyteplugins.agents.pydantic_ai"
title = "Pydantic AI"
name = "agents-pydantic-ai"
output_folder = "content/api-reference/integrations/agents/pydantic-ai"

# Frozen agentic plugins. flyteplugins-{anthropic,gemini,openai} were removed from
# the SDK; agents now run on Flyte through the framework adapters documented under
# content/integrations/agents/. Their API-reference dirs are retained by hand as
# version-stamped snapshots carrying a deprecation notice, for users still on an
# older release. Listed here (rather than deleted) so the registry stays the full
# account of what lives under output_base; `frozen` keeps the regen, clean, and
# PyPI drift checks off them. Do not unfreeze - the packages no longer publish.
[[plugins]]
package = "flyteplugins-anthropic"
plugin = "flyteplugins.anthropic"
title = "Anthropic"
name = "anthropic"
frozen = true

[[plugins]]
package = "flyteplugins-bigquery"
plugin = "flyteplugins.bigquery"
title = "BigQuery"
name = "bigquery"

[[plugins]]
package = "flyteplugins-codegen"
plugin = "flyteplugins.codegen"
title = "Code generation"
name = "codegen"

[[plugins]]
package = "flyteplugins-dask"
plugin = "flyteplugins.dask"
title = "Dask"
name = "dask"

[[plugins]]
package = "flyteplugins-databricks"
plugin = "flyteplugins.databricks"
title = "Databricks"
name = "databricks"

[[plugins]]
package = "flyteplugins-gemini"
plugin = "flyteplugins.gemini"
title = "Gemini"
name = "gemini"
frozen = true  # see "Frozen agentic plugins" above

[[plugins]]
package = "flyteplugins-huggingface"
plugin = "flyteplugins.huggingface"
title = "Hugging Face"
name = "huggingface"

[[plugins]]
package = "flyteplugins-hydra"
plugin = "flyteplugins.hydra"
title = "Hydra"
name = "hydra"

[[plugins]]
package = "flyteplugins-jsonl"
plugin = "flyteplugins.jsonl"
title = "JSONL"
name = "jsonl"

[[plugins]]
package = "flyteplugins-mlflow"
plugin = "flyteplugins.mlflow"
title = "MLflow"
name = "mlflow"

[[plugins]]
package = "flyteplugins-openai"
plugin = "flyteplugins.openai"
title = "OpenAI"
name = "openai"
frozen = true  # see "Frozen agentic plugins" above

[[plugins]]
package = "flyteplugins-omegaconf"
plugin = "flyteplugins.omegaconf"
title = "OmegaConf"
name = "omegaconf"

[[plugins]]
package = "flyteplugins-papermill"
plugin = "flyteplugins.papermill"
title = "Papermill"
name = "papermill"

[[plugins]]
package = "flyteplugins-polars"
plugin = "flyteplugins.polars"
title = "Polars"
name = "polars"

[[plugins]]
package = "flyteplugins-pytorch"
plugin = "flyteplugins.pytorch"
title = "PyTorch"
name = "pytorch"

[[plugins]]
package = "flyteplugins-ray"
plugin = "flyteplugins.ray"
title = "Ray"
name = "ray"

[[plugins]]
package = "flyteplugins-sglang"
plugin = "flyteplugins.sglang"
title = "SGLang"
name = "sglang"

[[plugins]]
package = "flyteplugins-spark"
plugin = "flyteplugins.spark"
title = "Spark"
name = "spark"

[[plugins]]
package = "flyteplugins-union"
plugin = "flyteplugins.union"
title = "Union plugin"
name = "union-plugin"
# Promoted out of the shared integrations/ base to a top-level api-reference section,
# positioned in the nav between flyte-sdk (weight 4) and integrations (weight 6).
output_folder = "content/api-reference/union-plugin"
weight = 5
# Union-only: the union plugin is not part of open-source Flyte.
variants = "-flyte +union"

[[plugins]]
package = "flyteplugins-vllm"
plugin = "flyteplugins.vllm"
title = "vLLM"
name = "vllm"

[[plugins]]
package = "flyteplugins-wandb"
plugin = "flyteplugins.wandb"
title = "Weights & Biases"
name = "wandb"

[[plugins]]
package = "flyteplugins-snowflake"
plugin = "flyteplugins.snowflake"
title = "Snowflake"
name = "snowflake"