Skip to content

API Reference

The public package exports:

from libterraform import (
    AsyncTerraformCommand,
    ProcessTerraformCommand,
    TerraformCommand,
    TerraformConfig,
    TerraformPool,
    ThreadTerraformCommand,
)

Exception classes are available from libterraform.exceptions.

Pages

  • TerraformCommand covers command execution, process and thread backends, CommandResult, option conversion, JSON parsing, and Terraform CLI helper methods.
  • AsyncTerraformCommand covers asyncio-compatible command execution for asyncio applications.
  • TerraformPool covers process-based parallel execution of Terraform commands.
  • TerraformConfig covers Terraform configuration parsing.
  • Results & Streaming covers the structured PlanResult / ApplyResult types and the TerraformStream streaming helper.
  • Exceptions covers package exception types.

The reference pages are generated from the Python source and docstrings with mkdocstrings.