Pyvider Framework¶

Pyvider is a comprehensive Python framework for building Terraform providers. It implements the complete Terraform plugin protocol, allowing you to create providers in Python rather than Go, with full support for resources, data sources, and provider configuration.

Architecture¶

graph TB
    subgraph "Core Framework"
        pyvider[pyvider<br/>Main Framework]
        cty[pyvider-cty<br/>Type System]
        hcl[pyvider-hcl<br/>HCL Parsing]
    end

    subgraph "Plugin Protocol"
        rpc[pyvider-rpcplugin<br/>gRPC Protocol]
    end

    subgraph "Extensions"
        components[pyvider-components<br/>Reusable Components]
        tofusoup[tofusoup<br/>Conformance Testing]
    end

    pyvider --> cty
    pyvider --> hcl
    pyvider --> rpc
    components --> pyvider
    tofusoup -.tests.-> pyvider

    style pyvider fill:#4051b5,stroke:#fff,color:#fff
    style cty fill:#5c6bc0,stroke:#fff,color:#fff
    style hcl fill:#5c6bc0,stroke:#fff,color:#fff
    style rpc fill:#7986cb,stroke:#fff,color:#fff
    style components fill:#9fa8da,stroke:#fff,color:#fff
    style tofusoup fill:#c5cae9,stroke:#333,color:#333

Framework Components¶

The Pyvider framework is composed of several specialized packages that work together:

Core Layer (pyvider, pyvider-cty, pyvider-hcl):

pyvider: Main framework orchestrating provider lifecycle, resource management, and Terraform integration
pyvider-cty: Python bindings for Terraform's CTY type system, enabling type-safe data handling
pyvider-hcl: HCL parsing and manipulation for configuration processing

Protocol Layer (pyvider-rpcplugin):

Implements Terraform's gRPC plugin protocol (versions 5 and 6)
Handles communication between Terraform CLI and Python providers
Manages plugin lifecycle, health checks, and graceful shutdown

Extension Layer (pyvider-components, tofusoup):

pyvider-components: Library of reusable provider components (CRUD patterns, state management, validation)
tofusoup: Cross-language conformance testing framework ensuring providers behave correctly across Terraform/OpenTofu

Framework Design¶

Pyvider follows Terraform's provider architecture while leveraging Python's strengths:

Type Safety: Uses Pydantic models for resource schemas, validated at runtime
Async Support: Native async/await for I/O-bound operations (API calls, database queries)
Developer Experience: Python's ecosystem, tooling, and ergonomics for rapid development
Protocol Compliance: Full implementation of Terraform plugin protocol for compatibility

The framework handles the complexity of Terraform's plugin protocol, allowing you to focus on implementing your provider's business logic.

Packages¶

Pyvider

Core framework for building Terraform providers in Python with full protocol support.

Explore Pyvider
Pyvider CTY

Python bindings for Terraform's CTY type system, enabling type-safe data handling.

Explore CTY
Pyvider HCL

HCL parsing and manipulation for Terraform configuration processing.

Explore HCL
Pyvider RPC Plugin

gRPC plugin protocol implementation for Terraform provider communication.

Explore RPC Plugin
Pyvider Components

Reusable provider components, patterns, and utilities for common use cases.

Explore Components
TofuSoup

Cross-language conformance testing framework for Terraform and OpenTofu providers.

Explore TofuSoup