Facilitates a convenient use of configuration files
A very simple and lightweight configuration loader and parser for Python.
- ini files (*.ini)
- json files (*.json)
- yaml files (*.yml, *.yaml)
pip install conf
Installation with support for YAML:
pip install "conf[yaml]"
Starting your app
Start your app with your configuration file:
python your_app.py --config your_config.yml
python your_app.py --config config_env_var
The --config argument can be:
- a relative path to a file;
- an absolute path to a file;
- the name of an environment variable which value holds one of the above.
You are allowed to provide multiple configuration names (separated by a single space), in which case any setting of a former configuration file can be overwritten by a setting of a later configuration file (if the name of that setting is identical).
Once you have supplied your application with some configuration, you can fetch the settings of that configuration. There are three options of how to do that.
Fetching your setting (option 1)
Simply get your setting from the conf module:
import conf your_setting = conf.your_setting
Fetching your setting (option 2)
Import your setting directly:
from conf import your_setting
Fetching your setting (option 3)
You can provide a default value if you are not sure the setting will be present:
import conf your_setting = conf.get('your_setting', 'your default value')
Note: If you use an ArgumentParser in your own application for other purposes, you must use the parse_known_args() method of the parser.
Fetching your setting (option 4)
You can get the configuration as a dictionary and get your setting as you would get any value from a dict:
import conf conf_dict = conf.asdict() your_setting = conf_dict.get('your_setting', 'your default value')
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.