hyperconf 0.3.0

YAML-based configuration library, featuring zero-code validation and parsing.

HyperConfig

Overview

HyperConfig is a Python library for creating schema-based configuration files. It automatically parses parses, validates and converts configuration objects according to a predefined configuration schema.

Advantages:

• less code: define the structure in YAML, validate and load configs using a one-liner.
• shared schemas: define once, use in multiple projects.
• extensibility: add configuration types and validation rules without coding.

Installation

pip install hyperconf

Usage

Define your schema in a definition file, ships.yaml:

  # Spaceship Configuration Schema
  ship_type:
    type: str
    validator: hval.isalpha()
    required: true

  shipcolor:
    type: str
    validator: hval.lower() in ['red', 'blue', 'green', 'yellow', 'gray']
    required: true

  enginepower:
    type: int
    validator: 100 <= hval <= 1000
    required: true

  shieldlevel:
    type: percent
    required: true

  ship:
    captain: str
    crew:
      type: int
      validator: hval > 0
    class: shiptype
    color: shipcolor
    shields: shieldlevel
    engines: enginepower

Then use the schema to create configuration values, gameconfig.yaml:

use: ships

ncc1701=ship:
  captain: James T. Kirk
  crew: 203
  class: constitution
  color: gray
  shields: 1.0
  engines: 900

and load it:

>>> from hyperconfig import HyperConf
>>> config = HyperConf.load("gameconfig.yaml")
>>> print(config.ncc1701.captain)

Please check the documentation at https://hyperconf.readthedocs.io/en/latest/index.html

License

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