Merge your config files and set parameters from the command line in a simple way.
Project description
CLI Config
CLI Config: Lightweight library that provides routines to merge nested configs and set parameters from command line. It is also provide processing functions that can change the whole configuration before and after each config merge, config saving and config loading. It also contains many routines to manipulate the config as flatten or nested dicts.
Documentation: here
Installation
In a new virtual environment, simply install the package with:
pip install cliconfig
This package is OS independent and supported on Linux, macOS and Windows.
Minimal usage
Make default config file(s) in your project (configs are merged from left to right):
# main.py
from cliconfig import make_config
config = make_config('default1.yaml', 'default2.yaml')
config_dict = config.dict # native python dict
Then launch your script with additional config(s) file(s) and parameters by command line. By default, these additional configs cannot add new parameters to the default config (for security and retro-compatibility reasons). For instance:
python main.py --config first.yaml,second.yaml --param2=-2 --letters.letter2='B'
See Quick Start section of the documentation for more details.
With processing
The library provide powerfull tools to modify the configuration called "processings". One of the possibility they add is to merge multiple configurations, copy a parameter on another, enforce type and more. To do so, simply adding the corresponding tags to your parameter names (on config files or CLI parameters). For instance with these config files:
--- # main.yaml
path_1@merge_add: sub1.yaml
path_2@merge_add: sub2.yaml
config3.select@select: "config3.param1"
--- # sub1.yaml
config1:
param@copy@type:int: config2.param2
param2@type:int: 1
--- # sub2.yaml
config2.param@type:None|int: 2
config3:
param1: 0
param2: 1
Here main.yaml
is interpreted like:
path_1: sub1.yaml
path_2: sub2.yaml
config1:
param: 2 # the value of config2.param2
param2: 1
config2:
param: 2
config3:
select: "config3.param1"
param1: 0
Then, all the parameters in config1
and config2
have enforced types
(config1.param
can also be None) and changing config2.param
will also update
config1.param
accordingly (which is protected by direct update).
See Processing section of the documentation for details on processing and how to create your own.
How to contribute
For development, install the package dynamically and dev requirements with:
pip install -e .
pip install -r requirements-dev.txt
Everyone can contribute to CLI Config, and we value everyone’s contributions. Please see our contributing guidelines for more information 🤗
Todo
Priority:
- allow passing new arguments by CLI (with warning and no actual merge)
- add a routine to check if a tag is in a key and robust to all other possible tags
- add an integration test with all built-in processing (and more)
Secondary:
- add
make_processing_keep_property
to make a processing that keep the property of a parameter across merged configs. The property is any python object returned by a function that takes the parameter as input - add
ProcessSelect
(with tag "@select") to select a subconfig (or parameter) and delete the others configs at the same level (to cure the resulting config) - allow nested types in
ProcessTyping
- add DefaultProcessings that stores default processing as list of processing
License
Copyright (C) 2023 Valentin Goldité
This program is free software: you can redistribute it and/or modify it under the terms of the MIT License. This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.
This project is free to use for COMMERCIAL USE, MODIFICATION, DISTRIBUTION and PRIVATE USE as long as the original license is include as well as this copy right notice at the top of the modified files.
Project details
Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for cliconfig-0.5.4-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0407520dcc8977286a7b5534ce7623de9e92e88f1956a503144ec9930177753e |
|
MD5 | a7fdc99b181fc19bc9e61d390fe91005 |
|
BLAKE2b-256 | 4a1e30f45561bdd38dafa54858ebd66d66a62e58e7a180104d7421baba73a55a |