proteus-config 1.1.0

Unified configuration management library for Python

Proteus

Unified Configuration Management Library for Python

Proteus is a Python library that provides a clean, pattern-based approach to managing application configurations. It allows you to load settings from multiple formats (JSON, YAML, TOML, ENV) and access them through a unified interface, regardless of the source format.

---

Features

• Multi-format Support: Load configurations from JSON, YAML, and TOML files seamlessly.
• Unified Interface: Access all settings through a single, consistent API with dot-notation.
• Namespacing Support: Inject configurations into specific nested paths to avoid collisions.
• Smart Merging: Combine multiple configuration files with intelligent deep-merge.
• Translation Engine: Convert configuration files between formats programmatically.
• Thread-Safe: Optional singleton access via ConfigurationManager.instance().
• Context Manager: Use with ConfigurationManager.temporary() for isolated workspaces.
• Easily Extensible: Add support for new formats with minimal code.
• Zero Heavy Dependencies: Only requires pyyaml and python-dotenv.

---

🛠️ CLI

Proteus comes with a built-in Command Line Interface for quick configuration tasks:

# Convert between formats
proteus translate settings.env settings.json

# Read a specific key
proteus get config.yaml database.host

# Merge multiple files into one
proteus merge base.json prod.env --out final.toml

See CLI Documentation for more details.

---

Quick Start

Installation

Install Proteus directly from PyPI:

pip install proteus-config

Basic Usage

from proteus import Proteus
# or from proteus import ConfigurationManager

config = Proteus()
config.load("examples/configs/app.yaml")

print(config.get("app_name"))
print(config.get("database.host"))
print(config.get("server.port"))

For a shared application-wide instance, use Proteus.instance().

For detailed and comprehensive examples covering all formats, see the examples/ directory.

---

Architecture and Design Patterns

Proteus is built on a foundation of proven design patterns from the Gang of Four catalog:

• Optional Singleton Pattern: Global point of access to configuration.
• Context Manager: Isolated temporary workspaces.
• Facade Pattern: Simplified API over complex orchestration.
• Factory Method Pattern: Transparent format detection and creator selection.
• Template Method Pattern: Rigid algorithms for I/O with format-specific hooks.
• Adapter Pattern: Decoupling from third-party parsing libraries.

For detailed architecture documentation and diagrams, see:

• Architecture
• ConfigurationManager
• Format Creators
• Readers
• Writers
• Test Suite

---

Development and Contributing

If you wish to contribute to the project or understand the development workflow, please refer to our Developer Guide.

Project Structure

proteus/
├── src/proteus/           # Source code
│   ├── core.py            # ConfigurationManager
│   ├── exceptions.py      # Custom exceptions
│   ├── adapters/          # Format adapters
│   ├── formats/           # Creator classes for readers/writers
│   ├── readers/           # Template Method readers
│   └── writers/           # Template Method writers
├── examples/             # Usage examples and configs
└── docs/                 # Documentation

---

License

This project is licensed under the MIT License - see the LICENSE file for details.

---

Contact

Luca Di Leo

• GitHub: @lucadileo9
• Repository: proteus

---