loadcfg 0.1.0

A configuration helper library for JSON and YAML config files with dot-access.

loadcfg

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

• Install with: pip install loadcfg
• License: MIT License
• Maintained by: Daniel Korkin ([e-mail])
• Library Purpose: Easily load and validate configuration files (JSON and YAML)
• Documentation: loadcfg.readthedocs.io
• Code Coverage: Codecov Dashboard
• GitHub Repository: github.com/danielkorkin/loadcfg
• PyPI: pypi.org/project/loadcfg

Example Usage

from loadcfg import LoadJson, LoadYaml, Template, ConfigValidationError

# --- Loading a configuration file ---
config = LoadJson("config.json")
print(config.name)          # Access via attribute notation.
print(config.info.age)

# --- Defining a configuration template ---
class ProgramConfig(Template):
    name: str
    age: int
    # You can also define nested templates:
    # details: OtherTemplate

# Validate a loaded configuration
try:
    ProgramConfig.validate(config)
except ConfigValidationError as err:
    print("Configuration error:", err)

# Alternatively, validate directly from the config instance:
config.validate(ProgramConfig)

# --- Generating an example configuration ---
example_json = ProgramConfig.generate(fmt="json")
print(example_json)

example_yaml = ProgramConfig.generate(fmt="yaml")
print(example_yaml)

Testing

This library uses pytest for testing. To run tests locally, use:

pytest

Contributing

Contributions are encouraged and appreciated! Feel free to submit issues and pull requests on GitHub.

License

This project is licensed under the MIT License.

Contact

Maintained by Daniel Korkin ([e-mail])