confease documentation

confease is a small Python configuration helper for applications that need predictable configuration precedence across defaults, files, environment variables, and CLI arguments.

Use it when you want one shared configuration object that can:

• Start from in-code defaults.

• Load user and system configuration files.

• Accept environment-variable overrides for known keys.

• Accept argparse.Namespace CLI overrides.

• Persist user-origin values back to disk.

• Work with common configuration formats through a simple parser interface.

Start with the installation guide if you are setting up the package, or jump to the quickstart for the first working example.

User Guide

• Installation
  • From Source
  • Development Commands
• Quickstart
  • Nested Keys
  • Parser Selection
• Configuration Model
  • Source Origins
  • Custom Precedence
  • Defaults
  • Environment Variables
  • CLI Values
  • Persistence
  • Editing Files Safely
  • Limitations
• File Formats
  • Supported Suffixes
  • YAML
  • JSON
  • TOML
  • INI, CFG, CONF, and CONFIG
  • XML
  • CSV
  • Nesting Rules
  • Type Round-Tripping
• Examples
  • Application Configuration
  • Save User Preferences
  • Load a Specific Format
  • Runtime-Only Configuration
  • Read Sections
  • Edit a Config File
• Troubleshooting
  • A Saved File Is Empty Or Missing Defaults
  • Environment Variables Are Ignored
  • Nested Keys Raise A Collision Error
  • A CLI Value Did Not Override A File
  • Editing A File Fails
• Changelog
• License

Reference

• API Reference
  • Core API
  • Parser API

Project Status

confease is currently an alpha Python prototype. The public API is small and focused, but behavior may still evolve before a stable release.

Project Links

• Repository: octanima-labs/confease

• Issues: octanima-labs/confease#issues

• Documentation: https://octanima-labs.github.io/confease