logo
Provide Foundry Documentation
SUMMARY
Initializing search
    provide-io/provide-foundry
    • Foundry
    • Foundation
    • Pyvider Framework
    • Development Tools
    provide-io/provide-foundry
    • Foundry
      • Architecture
      • Design Principles
      • Roadmap
      • Packages
        • Foundation
        • TestKit
        • FlavorPack
        • Pyvider
        • Pyvider CTY
        • Pyvider HCL
        • Pyvider RPC Plugin
        • Pyvider Components
        • Plating
        • TofuSoup
        • SupSrc
        • WrkNv
      • Getting Started
      • Guides
        • Installation
        • IDE Setup
        • Development Workflow
        • Testing Patterns
        • Documentation
        • Packaging
        • Provider Development
    • Foundation
      • foundation
        • Ecosystem
          • Features
          • Use Cases
          • What's New
        • Getting Started
          • Installation
          • 5-Minute Quick Start
          • Build a CLI App Tutorial
          • More Examples
            • Basic Logging
            • Exception Logging
            • Structured Events
            • Custom Processors
            • Environment Variables
            • File-Based Config
            • Secret Management
            • Building Commands
            • Argument Parsing
            • Interactive Prompts
            • Atomic Writes
            • File Watching
            • Key Generation
            • Signing & Verification
            • Certificates
            • Making Requests
            • Custom Middleware
            • Unit Testing
            • Testing CLI Commands
            • Retry Patterns
            • Circuit Breakers
            • Deployment Patterns
            • Monitoring & Observability
          • Troubleshooting
          • How Foundation Works
          • Dependency Injection
        • Reference
          • Core
            • Hub
            • Config
            • Errors
            • State
          • CLI & Console
            • Console
            • Context
          • Resilience & Observability
            • Metrics
            • Tracer
            • Observability
          • Data & Files
            • Archive
            • Serialization
            • Streams
          • Security
            • Security
          • Utilities
            • Concurrency
            • Formatting
            • Time
            • Process
            • Platform
            • Transport
            • Parsers
          • Advanced
            • Profiling
            • Testmode
            • Integrations
        • Specs
      • testkit
          • Installation
          • Quick Start
        • Quality Guide
        • API Reference
    • Pyvider Framework
      • pyvider
          • What is Pyvider
          • Installation
          • Quick Start
          • Building Your First Resource
          • Building Your First Data Source
          • Building an HTTP API Provider
            • Create a Resource
            • Add Validation
            • Create a Data Source
            • Handle Pagination
            • Creating Providers
            • Creating Functions
            • Using Decorators
            • Testing Providers
            • Debugging
            • Logging
            • Error Handling
            • Best Practices
            • Production Readiness
            • Security Best Practices
            • Performance Optimization
            • Provider Lifecycle
            • Advanced Patterns
            • Advanced Provider Features
            • Configuration
            • Managing Resources
            • Using Data Sources
            • Using Functions
          • Architecture
          • Component Model
          • Schema System
          • Resources vs Data Sources
          • Resource Lifecycle
          • Data Source API
            • Pyvider Components
          • Overview
          • Types
          • Attributes
          • Blocks
          • Validators
          • Computed Attributes
          • Sensitive Data
          • Schema by Example
          • Common Patterns
          • Best Practices
          • Overview
        • API Guide
          • CLI
          • Common
          • Hub
          • Providers
          • Resources
          • Data Sources
          • Functions
          • Ephemeral Resources
          • Exceptions
          • Observability
          • Schema
            • Types
          • Conversion
          • Protocols
          • pyvider
            • capabilities
              • base
              • decorators
            • cli
              • components_commands
              • config_commands
              • context
              • install_command
              • launch_context_command
              • main
              • provide_command
              • utils
            • common
              • config
              • context
              • encryption
              • launch_context
              • operation_context
              • types
              • utils
                • attrs_factory
                • availability
            • conversion
              • adapter
              • context
              • marshaler
              • schema_adapter
              • utils
            • data_sources
              • base
              • decorators
            • ephemerals
              • base
              • context
              • decorators
            • exceptions
              • base
              • foundation
              • function
              • grpc
              • provider
              • registry
              • resource
              • schema
              • serialization
              • validation
            • functions
              • adapters
              • base
              • decorators
            • handler
            • hub
              • components
              • discovery
              • validators
            • observability
              • metrics
            • protocols
              • service
              • tfprotov6
                • handlers
                  • apply_resource_change
                  • call_function
                  • close_ephemeral_resource
                  • configure_provider
                  • get_functions
                  • get_metadata
                  • get_provider_schema
                  • import_resource_state
                  • move_resource_state
                  • open_ephemeral_resource
                  • plan_resource_change
                  • read_data_source
                  • read_resource
                  • renew_ephemeral_resource
                  • stop_provider
                  • upgrade_resource_state
                  • utils
                  • validate_data_resource_config
                  • validate_ephemeral_resource_config
                  • validate_provider_config
                  • validate_resource_config
                • protobuf
                • utils
            • providers
              • base
              • config
              • context
              • decorators
              • provider
            • resources
              • base
              • context
              • decorators
              • exceptions
              • lifecycle
              • private_state
              • protocol
              • types
            • schema
              • exceptions
              • factory
              • transforms
              • types
                • attribute
                • blocks
                • enums
                • object
                • schema
                • types_base
            • testmode
              • fixtures
        • âš¡ Quick Reference
        • FAQ
        • Troubleshooting
        • Glossary
          • Guidelines
          • Code of Conduct
          • Roadmap
      • pyvider-cty
        • Getting Started
          • Installation
          • Quick Start (5 min)
          • Your First Type System
          • Examples
        • User Guide
            • Understanding Types
            • Working with Values
            • Validation
            • Type Conversion
            • Primitive Types
            • Collection Types
            • Structural Types
            • Dynamic Types
            • Capsule Types
            • Marks System
            • Built-in Functions
            • Serialization
            • Path Navigation
            • Terraform Interop
        • How-To Guides
          • Validate Data
          • Serialize Values
          • Work with Terraform
          • Create Custom Types
          • Migrate from go-cty
        • API Guide
          • Types
            • Primitives
            • Collections
            • Structural
            • Capsule
          • Values
          • Conversion
          • Codec
          • Functions
          • Path Navigation
          • Validation
          • Context
          • pyvider
            • cty
              • codec
              • config
                • defaults
                • runtime
              • context
                • validation_context
              • conversion
                • adapter
                • explicit
                • inference_cache
                • raw_to_cty
                • type_encoder
              • exceptions
                • base
                • conversion
                • encoding
                • validation
              • functions
                • bytes_functions
                • collection_functions
                • comparison_functions
                • conversion_functions
                • datetime_functions
                • encoding_functions
                • numeric_functions
                • string_functions
                • structural_functions
              • marks
              • parser
              • path
                • base
              • types
                • base
                • capsule
                • capsule_types
                • collections
                  • list
                  • map
                  • set
                • primitives
                  • bool
                  • number
                  • string
                • structural
                  • dynamic
                  • object
                  • tuple
              • validation
                • recursion
              • values
                • base
                • markers
          • Troubleshooting
          • Glossary
          • go-cty Comparison
          • Release Notes
      • pyvider-hcl
          • Quick Start
          • Installation
        • User Guide
        • Architecture
          • Parsing HCL
          • Schema Validation
          • Type Inference
          • Terraform Integration
          • Error Handling
          • Testing
          • pyvider
            • hcl
              • exceptions
              • factories
                • resources
                • types
                • variables
              • output
                • formatting
              • parser
                • base
                • context
                • inference
              • terraform
                • config
      • pyvider-rpcplugin
        • Introduction
          • Foundation Integration
        • Getting Started
          • Installation
          • Quick Start
          • Your First Plugin
          • Examples Overview
        • User Guide
          • Core Concepts
            • RPC Architecture
            • Transports
            • Protocols
            • Handshake Process
            • Security Model
          • Server Development
            • Basic Server Setup
            • Service Implementation
            • Transport Configuration
            • Async Patterns
            • Health Checks
          • Client Development
            • Basic Client Setup
            • Connection Management
            • Direct Connections
            • Error Handling
            • Retry Logic
          • Security
            • mTLS Configuration
            • Certificate Management
            • Certificate API Reference
            • Magic Cookies
            • Process Isolation
          • Configuration
            • Configuration Reference
            • Config vs Factory Parameters
            • Client Configuration
            • Server Configuration
            • Security Configuration
            • Advanced Configuration
            • Environment Variables
            • Production Setup
            • Rate Limiting
            • Logging Configuration
          • Advanced Topics
            • Type System
            • Custom Protocols
            • Performance Tuning
            • Telemetry & Observability
            • Middleware
            • Plugin Lifecycle
          • Best Practices
          • None
        • Examples
            • Basic Echo
            • Intermediate Patterns
            • Advanced Patterns
            • Basic Client
            • Basic Server
            • Health Check
            • Rate Limiting
            • TCP Transport
            • Custom Protocol
        • Development
          • Contributing
          • Architecture
          • Testing
          • CI/CD
          • Troubleshooting
      • pyvider-components
          • Understand the Pyvider Framework
          • Build Your Own Provider with Pyvider
          • timed_token
          • env_variables
          • nested_data_processor
          • provider_config_reader
          • add
          • contains
          • divide
          • format
          • format_size
          • join
          • length
          • lookup
          • lower
          • max
          • min
          • multiply
          • pluralize
          • replace
          • round
          • split
          • subtract
          • sum
          • to_camel_case
          • to_kebab_case
          • to_snake_case
          • tostring
          • truncate
          • upper
            • file_content
            • local_directory
            • file_info
            • lens_jq
            • lens_jq
            • http_api
            • private_state_verifier
            • warning_example
            • mixed_map_test
            • nested_resource_test
            • simple_map_test
            • structured_object_test
      • terraform-provider-pyvider
          • Tour the Example Provider
          • Getting Started with Pyvider
          • Troubleshooting
            • timed_token
            • env_variables
            • nested_data_processor
            • provider_config_reader
            • add
            • contains
            • divide
            • format
            • format_size
            • join
            • length
            • lookup
            • lower
            • max
            • min
            • multiply
            • pluralize
            • replace
            • round
            • split
            • subtract
            • sum
            • to_camel_case
            • to_kebab_case
            • to_snake_case
            • tostring
            • truncate
            • upper
            • file_content
            • local_directory
            • file_info
            • lens_jq
            • lens_jq
            • http_api
            • private_state_verifier
            • warning_example
            • mixed_map_test
            • nested_resource_test
            • simple_map_test
            • structured_object_test
      • tofusoup
          • What is TofuSoup?
          • Installation
          • Quick Start
          • Architecture
          • Conformance Testing
          • Migration Guide
            • CTY and HCL Tools
            • Wire Protocol
            • Matrix Testing
            • Configuration Management
            • State Inspection
            • Running Conformance Tests
            • Test Harness Development
          • Overview
          • Conformance Testing Strategy
          • RPC Matrix Specification
          • Wire Protocol Details
          • Polyglot CLI Strategy
          • Stock Service Design
          • soup-go vs Terraform
        • Reference
          • Configuration
          • Compatibility Matrix
          • Conformance Test Status
          • Cross-Language Compatibility
        • FAQ
        • Troubleshooting
        • Glossary
        • Changelog
    • Development Tools
      • flavorpack
        • Roadmap
        • Getting Started
          • Installation
          • Quick Start
          • First Package
          • Examples
        • Tutorials
          • HTTPie Wrapper
        • User Guide
          • Core Concepts
            • PSPF Format
            • Package Structure
            • Work Environments
            • Security Model
            • Helper Binaries
          • Building Packages
            • Python Applications
            • Manifest Files
            • Configuration
            • Signing Packages
            • Platform Support
          • Using Packages
            • Running Packages
            • CLI Reference
            • Inspecting Packages
            • Cache Management
            • Environment Variables
          • Advanced Topics
            • Cross-Language Support
            • Custom Launchers
            • Custom Builders
            • Performance Tuning
            • Debugging
        • API Guide
          • Packaging API
          • Builder API
          • Reader API
          • Crypto API
          • flavor
            • cache
            • cli
            • commands
              • extract
              • helpers
              • inspect
              • keygen
              • package
              • utils
              • verify
              • workenv
            • config
              • config
              • defaults
              • manager
            • console
            • exceptions
            • helpers
              • binary_loader
              • manager
            • locking
            • output
            • package
            • packaging
              • keys
              • orchestrator
              • orchestrator_helpers
              • python
                • dependency_resolver
                • dist_manager
                • environment_builder
                • packager
                • pypapip_manager
                • slot_builder
                • uv_manager
                • wheel_builder
            • psp
              • format_2025
                • backends
                • builder
                • constants
                • environment
                • executor
                • extraction
                • generated
                  • modules
                • handlers
                • keys
                • launcher
                • metadata
                  • assembly
                • operations
                • pe_utils
                • pspf_builder
                • reader
                • slots
                • spec
                • validation
                • workenv
                • writer
              • metadata
                • paths
                • validators
              • protocols
              • security
            • utils
              • xor
            • verification
        • Cookbook
          • Examples
            • CLI Tools
            • Web Applications
          • Recipes
            • Docker Integration
            • CI/CD Pipelines
            • Multi-Platform Builds
        • Reference
          • System Requirements
          • Glossary
            • PSPF 2025
            • Slot Descriptor Spec
            • FEP-0001 Core Format
            • FEP-0002 JSON Metadata
            • FEP-0003 Operation Registry
              • FEP-0004 Supply Chain JIT
              • FEP-0005 Runtime JIT
              • FEP-0006 Staged Payload
          • Troubleshooting
            • Common Issues
            • Error Messages
            • Platform-Specific
              • macOS Issues
              • Linux Issues
              • Windows Issues
            • FAQ
          • Development
            • Contributing
            • Architecture
            • Building Helpers
            • Testing
              • Unit Tests
              • Taster vs Pretaster
              • Integration Tests
              • Cross-Language Tests
            • CI/CD
            • Release Process
          • Community
            • Getting Support
            • Discussions
            • Contributing
            • Blog
            • Changelog
            • License
      • wrknv
          • Installation
          • wrknv
            • cli
              • commands
                • config
                • container
                • doctor
                • gitignore
                • lock
                • profile
                • secrets
                • setup
                • terraform
                • tools
                • workspace
              • hub_cli
              • nested_commands
              • visual
            • config
              • core
              • defaults
              • display
              • persistence
              • sources
              • validation
            • container
              • commands
              • core
              • errors
              • manager
              • metadata
              • operations
                • build
                • exec
                • lifecycle
                • logs
                • volumes
              • runtime
                • base
                • docker
              • shell_commands
              • storage
            • errors
            • gitignore
              • builder
              • detector
              • manager
              • templates
            • lockfile
            • logging
              • emojis
              • setup
            • managers
              • bao
              • base
              • factory
              • github
                • client
                • types
              • go
              • subrosa
                • bao
                • base
                • ibm
              • tf
                • base
                • bin_ops
                • ibm
                • metadata
                • tofu
                • utils
              • uv
            • testing
              • helpers
            • utils
              • python_version
              • version_resolver
            • wenv
              • bin_manager
              • completions
              • doctor
              • env_generator
              • exceptions
              • operations
                • download
                • install
                • platform
                • verify
              • resilience
              • schema
              • workenv
            • workspace
              • discovery
              • manager
              • schema
              • sync
      • supsrc
          • Installation
        • API Reference
      • plating
          • Quick Start
          • Authoring Bundles
          • Examples
          • API Reference
          • CLI Reference
          • Registry Pattern
          • Performance
          • Troubleshooting
        • API Documentation
            • Overview
            • Adorner

    SUMMARY

    • pyvider
      • components
        • capabilities
          • api
          • core
          • lens
        • data_sources
          • env_variables
          • file_info
          • http_api
          • lens_jq
          • nested_data_test_suite
          • provider_config_reader
        • functions
          • collection_functions
          • lens_jq
          • numeric_functions
          • string_manipulation
          • type_conversion_functions
        • helpers
        • provider
        • resources
          • file_content
          • local_directory
          • private_state_verifier
          • timed_token
          • warning_example
    Made with Material for MkDocs