Welcome to omniconf’s documentation!

Contents:

• Getting started
  • Installing
  • Choosing a configuration approach
• Functional approach
  • How to use
  • Functions
• Typed registry approach
  • How to use
  • Defining a registry
  • Defining settings
  • Debugging
• Design principles
  • Keys
  • Terminology
• Supported backends
  • generic backend interface
  • dict backend interface
  • commandline arguments
  • environment variables
  • ConfigObj files
  • JSON files
  • TOML files
  • YAML files
• Setting types
  • Built-in interpretation
  • Custom interpretation and types
• Type annotations
  • Prerequisites
  • Enabling the plugin
  • Annotating settings
  • Debugging mypy plugin
• Advanced usage
  • Core types
  • Custom (functional) registries
  • Autoconfigure setting prefix
  • Backend setting prefix
  • Outputting usage information

Indices and tables

• Index

• Search Page