konfik 0.1.6

The Strangely Familiar Config Parser

>> The Strangely Familiar Config Parser <<

📖 Description

Konfik is a simple configuration parser that helps you access your TOML or DOTENV config variables using dot (.) notation. This enables you to do this:

foo_bar_bazz = config.FOO.BAR.BAZZ

instead of this:

foo_bar_bazz = config["FOO"]["BAR"]["BAZZ"]

⚙️ Installation

Install Konfik via pip:

pip install konfik

💡 Examples

Let's see how you can parse a TOML config file and access the variables there. For demonstration, we'll be using the following config.toml file:

# example_config.toml

title = "TOML Example"

[owner]
name = "Tom Preston-Werner"
dob = 1979-05-27T07:32:00-08:00 # First class dates

[servers]
  [servers.alpha]
  ip = "10.0.0.1"
  dc = "eqdc10"

  [servers.beta]
  ip = "10.0.0.2"
  dc = "eqdc10"

[clients]
data = [ ["gamma", "delta"], [1, 2] ]

To parse this in Python:

from pathlib import Path
from konfik import Konfik

BASE_DIR = Path(".").parent

# Define the config paths
CONFIG_PATH_TOML = BASE_DIR / "example_config.toml"

# Initialize the Konfik class
konfik = Konfik(config_path=CONFIG_PATH_TOML)

# Serialize and print the config file
konfik.serialize()

# Access the serialized config object
config = konfik.config

# Use the serialized config object to acess the config variable via dot notation
title = config.title
name = config.owner.name
server_alpha_ip = config.servers.alpha.ip
clients = config.client

The .serialize() method will print your entire config file as a colorized Python dictionary object like this:

{
    'title': 'TOML Example',
    'owner': {
        'name': 'Tom Preston-Werner',
        'dob': datetime.datetime(1979, 5, 27, 7, 32, tzinfo=<toml.tz.TomlTz object at
0x7f2dfca308b0>)
    },
    'database': {
        'server': '192.168.1.1',
        'ports': [8001, 8001, 8002],
        'connection_max': 5000,
        'enabled': True
    },
    'servers': {
        'alpha': {'ip': '10.0.0.1', 'dc': 'eqdc10'},
        'beta': {'ip': '10.0.0.2', 'dc': 'eqdc10'}
    },
    'clients': {'data': [['gamma', 'delta'], [1, 2]]}
}

Konfik also exposes a few command-line options for you to introspect your config file and variables. Run:

konfik --help

This will reveal the options associated with the CLI tool:

usage: konfik [-h] [--show SHOW] [--path PATH] [--serialize] [--version]

Konfik CLI

optional arguments:
  -h, --help   show this help message and exit
  --show SHOW  show variables from config file
  --path PATH  add custom config file path
  --serialize  print the serialized config file
  --version    print konfik-cli version number

To inspect the value of a specific variable in a config.toml file you can run:

konfik --show servers.alpha.ip

If you're using a config that's not named as config.toml then you can deliver the path using the --path argument like this:

konfik --path settings/example_config.env --show name

🙋 Why

While working with machine learning models, I wanted an easier way to tune the model parameters without mutating the Python files. I needed something that would simply enable me to access tuple or dictionary data structures from a config file. I couldn't find anything that doesn't try to do a gazillion of other kinds of stuff or doesn't come with the overhead of a significant learning curve.

Neither DOTENV nor YAML catered to my need as I was after something that gives me the ability to store complex data structures without a lot of fuss -- so TOML it is. However, since DOTENV is so ubiquitous for config management, Konfik supports that too. Also, not having to write angle brackets ([""]) to access dictionary values is nice!

🎉 Contribution Guidelines

Currently, Konfik doesn't support .yaml out of the box. Maybe that's something you'd like to take a jab at. To do so,

• Clone the repo

• Spin up and activate your virtual environment. You can use anything between Python 3.6 to Python 3.9.

• Install poetry

• Install the dependencies via:

  poetry install
  

• Make your changes to the konfik/main.py file

• Run the tests via the following command. Make sure you've Python 3.6 - Python 3.9 installed, otherwise tox would throw an error.

  tox
  

• Write a simple unit test for your change

• Run the linter via:

  make linter