Conftier

A powerful multi-tier configuration management framework that simplifies the definition, access, and synchronization of layered configurations in Python applications.

Think of VSCode's configuration system: you have user settings that apply globally and workspace settings that override them for specific projects. Conftier brings this same intuitive model to your Python frameworks and applications.

Documentation

For comprehensive guides, examples, and API reference, visit our documentation:

• Introduction
• Quick Start Guide
• Contributing

Overview

Conftier helps you manage configurations across multiple levels:

• User-level settings: Global preferences that apply across all projects (~/.zeeland/{config_name}/config.yaml)
• Project-level settings: Local configurations specific to a project (./.{config_name}/config.yaml)
• Default values: Fallback values defined in your configuration schema

Conftier automatically merges these configurations based on priority (project > user > default).

Key Features

• Multi-level Configuration Management: Like VSCode's user/workspace settings pattern
• Flexible Schema Definition: Use Pydantic models or dataclasses to define and validate configurations
• Type Safety: No more string/int confusion or missing required fields
• Smart Merging: Only override what's specified, preserving other values
• CLI Integration: Built-in command-line tools for configuration management
• IDE Autocompletion: Full type hints for a great developer experience

Why Conftier?

Installation

# Basic installation
pip install conftier

# With Pydantic support (recommended)
pip install conftier[pydantic]

Quick Example

from pydantic import BaseModel, Field
from conftier import ConfigManager

class AppConfig(BaseModel):
    app_name: str = "MyApp"
    debug: bool = False

config_manager = ConfigManager(
    config_name="myapp",
    config_schema=AppConfig,
    auto_create=True
)

# Load the merged configuration
config: AppConfig = config_manager.load()

When to Use Conftier

Conftier shines when:

1. You're building a framework or library: Give your users a consistent way to configure your tool
2. Your app has both user and project settings: Like VSCode's personal vs. project-specific settings
3. You need schema validation: Ensure configuration values have the correct types and valid ranges
4. You want to reduce boilerplate: Stop writing the same configuration loading code in every project

🛡 License

This project is licensed under the terms of the MIT license. See LICENSE for more details.

🤝 Support

For more information, please contact: zeeland4work@gmail.com

Credits

This project was generated with P3G