loadcfg Documentation

Welcome to the loadcfg documentation!

loadcfg is a lightweight Python library that makes it easy to load, validate, and generate configuration files in JSON and YAML formats—with intuitive dot-access to configuration values.

Key Features:

• Easy Loading: Quickly load configuration files (JSON or YAML) with a single function call.

• Dot-Notation Access: Access configuration values as attributes.

• Template Validation: Define configuration schemas using Python type annotations.

• Example Generation: Automatically generate example configurations in JSON or YAML.

• Extensible: Designed to be simple yet flexible for a variety of configuration tasks.

Contents:

• Usage Example
  • Installation
  • Loading a Configuration File
  • Defining and Validating a Configuration Template
  • Generating and Saving Example Configurations
  • Testing and Contributing
  • Documentation and Code Coverage
• loadcfg Module
  • Config
  • ConfigValidationError
  • GeneratedConfig
  • LoadIni()
  • LoadJson()
  • LoadToml()
  • LoadYaml()
  • Template

Indices and tables

• Index

• Module Index

• Search Page