Guides

The guides explain all of Typed Settings’ features in detail. You should read them when you know the basics and when you now what exactly you want to build. If you need inspiration on how to use the different features, you should stop by the Examples page.

Contents:

• Settings Classes
  • Writing Settings Classes
  • Secrets
  • Dynamic Options
  • Mypy
• Basic Settings Loading
  • Simple API: load()
  • Full API: load_settings()
• Environment Variables
  • Basics
  • Nested settings
  • Overriding the var name for a single option
• Config Files
  • Basics
  • Optional and Mandatory Config Files
  • Static Search Paths
  • Finding Files at Runtime
  • Using pyproject.toml
  • Dynamic Search Paths via Environment Variables
  • Config File Precedence
  • Adding Support for Additional File Types
• Writing Custom Loaders
• Post-processing Settings
  • Interpolation
  • Templating
  • Loading Secrets via Helper Scripts
• 1Password
  • 1Password Loader
  • URL Processor with 1Password handler
• CLIs with Argparse or Click
  • Argparse or Click?
• CLIs with Argparse
  • Tuning and Extending CLI generation
  • Customizing the Generated Arguments
  • Configuring Loaders and Converters
  • Working with the ArgumentParser and Namespace
  • Extending Supported Types
• CLIs with Click
  • Customizing the Generated Options
  • Passing Settings to Sub-Commands
  • Order of Decorators
  • Settings as Keyword Arguments
  • Configuring Loaders and Converters
  • Optional and Union Types
  • Extending Supported Types