Logo

User Guide

  • Overview
    • What is Confii?
    • Why Confii?
    • Use Cases
    • Key Concepts
  • Installation
    • Requirements
    • Basic Installation
    • Optional Dependencies
    • Individual Secret Store Dependencies
    • Verifying Installation
    • Next Steps
  • Quick Start
    • Basic Usage
    • Multiple Sources
    • With Secret Stores
    • With Schema Validation
    • Debug Mode
    • Alternative Access Methods
    • Next Steps
  • User Guide
    • Configuration Sources
      • File Loaders
      • Environment Variables
      • Cloud Storage
      • Remote URLs
    • Secret Stores
      • Quick Example
    • Schema Validation
      • Pydantic Validation
      • JSON Schema Validation
    • Advanced Features
      • Configuration Versioning
      • Drift Detection
      • Observability
      • Async Support

API Reference

  • API Reference
    • Core Classes
      • Config Class
        • Config
      • ConfigBuilder
        • ConfigBuilder
        • builder()
    • Loaders
      • Loaders
        • Configuration Loaders
        • Base Loader
        • YAML Loader
        • JSON Loader
        • TOML Loader
        • Environment Loader
        • Remote Loaders
    • Secret Stores
      • Secret Stores
        • AWSSecretsManager
        • AzureKeyVault
        • DictSecretStore
        • EnvSecretStore
        • GCPSecretManager
        • HashiCorpVault
        • MultiSecretStore
        • SecretResolver
        • SecretStore
    • Validators
      • Validators
        • Available Validators
        • PydanticValidator
        • SchemaValidator
    • Advanced Features
      • Async Configuration
        • AsyncConfig
        • AsyncHTTPLoader
        • AsyncLoader
        • AsyncYamlLoader
      • Configuration Diff
        • ConfigDiff
        • ConfigDiffer
        • ConfigDriftDetector
        • DiffType
      • Configuration Versioning
        • ConfigVersion
        • ConfigVersionManager
      • Observability
        • ConfigAccessMetric
        • ConfigEventEmitter
        • ConfigMetrics
        • ConfigObserver
      • Merge Strategies
        • AdvancedConfigMerger
        • MergeStrategy
    • Utilities
      • Configuration Introspection
        • get_all_keys()
        • get_nested_value()
        • get_schema_info()
        • has_key()
        • infer_type()
    • CLI
      • CLI Reference
    • Exceptions
      • Exceptions
        • ConfigAccessError
        • ConfigFormatError
        • ConfigLoadError
        • ConfigMergeConflictError
        • ConfigNotFoundError
        • ConfigValidationError
        • ConfiiError

Guides

  • Secret Store Integration
    • Table of Contents
    • Overview
    • Quick Start
      • Basic Usage
      • Configuration File
    • Secret Placeholder Syntax
      • Placeholder Format
    • Built-in Providers
      • DictSecretStore
      • EnvSecretStore
      • MultiSecretStore
      • AWS Secrets Manager
      • HashiCorp Vault
      • Azure Key Vault
      • GCP Secret Manager
    • Custom Secret Stores
    • Advanced Features
      • JSON Path Extraction
      • Secret Caching
      • Environment-Specific Prefixes
      • Fail-Safe Mode
    • Best Practices
      • 1. Use Environment-Specific Configuration
      • 2. Implement Fallback Hierarchy
      • 3. Enable Caching for Performance
      • 4. Use Descriptive Secret Keys
      • 5. Rotate Secrets Regularly
      • 6. Never Commit Secrets
      • 7. Use IAM/RBAC for Access Control
      • 8. Monitor Secret Access
      • 9. Test with Mock Stores
      • 10. Handle Secret Store Failures Gracefully
    • Examples
    • Troubleshooting
      • Placeholders Not Being Resolved
      • Authentication Errors
      • Performance Issues
    • License
  • Summary
    • ✅ What Was Implemented
      • 1. Extensible Authentication Architecture
      • 2. 10 Authentication Methods
      • 3. Enterprise Features
      • 4. Multi-Method Fallback
    • 📁 Files Created
    • 🎯 How It Answers Your Question
    • 🔐 Supported Password Policies
    • 📊 Complete Feature Matrix
    • 🚀 Usage in Production
    • ✨ Key Benefits
  • Migration Guide
    • Table of Contents
    • Why Migrate?
      • What You Gain
      • What You Keep
      • What’s Different (Tradeoffs)
    • Migration from python-dotenv
      • Before (python-dotenv)
      • After (Confii) — Untyped
      • After (Confii) — Typed with Config[T]
      • Step-by-Step Checklist
      • CLI Migration
    • Migration from python-decouple
      • Before (python-decouple)
      • After (Confii) — Untyped
      • After (Confii) — Typed with Config[T]
      • Step-by-Step Checklist
    • Migration from OmegaConf
      • Loading YAML files
      • Merging configs
      • Converting to plain dict
      • Variable interpolation
      • Structured configs → Config[T]
      • Step-by-Step Checklist
    • Migration from Dynaconf
      • Basic usage
      • Environment switching
      • Dynaconf Vault integration → Confii secret stores
      • Dynaconf validators → Pydantic with Config[T]
      • Step-by-Step Checklist
      • CLI Migration
    • Migration from Hydra
      • Removing the @hydra.main() decorator
      • Config groups → _include composition
      • defaults: list → _defaults: directive
      • hydra.utils.instantiate() — No equivalent
      • Multirun/sweep — No equivalent
      • Structured configs → Config[T]
      • Step-by-Step Checklist
      • CLI Migration
    • Migration from Pydantic Settings
      • The limitation of pydantic-settings
      • Before (pydantic-settings)
      • After (Confii) — Same typing, more sources
      • What changes, what stays the same
      • Step-by-Step Checklist
    • Automated Migration (CLI)
      • What the CLI does
      • What the CLI does NOT do
      • Output format options
    • Feature Comparison
    • Common Migration Patterns
      • Pattern 1: Environment variables only
      • Pattern 2: File + environment overrides
      • Pattern 3: Multiple environments
      • Pattern 4: Secrets from Vault + config from files
      • Pattern 5: Builder pattern for complex setups
    • Post-Migration Checklist
      • 1. Validate your configuration
      • 2. Enable schema validation
      • 3. Set up hot reloading (if needed)
      • 4. Integrate secret stores
      • 5. Use the debug tools
      • 6. Freeze config in production
    • Getting Help

Resources

  • Examples
    • Basic Examples
    • Introspection API
    • Validation Examples
    • Async Support
    • Advanced Features
    • Secret Stores
    • Running Examples
  • Contributing
    • Quick Links
Confii
  • Search

© Copyright 2024, confiify.