pi-conf 0.7.6.1

Easy configs for python projects

P-Conf

Easy use Configs for python projects. Allows loading the config files in the application directory (os specific). Once set the config can be used as a singleton across the project or pass around.

Locations for the config file

The following are the default locations that will be searched

• ~/.config/<appname>/config.(toml|json|ini|yaml)
• <system config directory>/<appname>/config.(toml|json|ini|yaml)

Example code

The example code uses the following as the example configuration file

# My config.toml file
foo = 1
[bar]
a = 2

Using inside of a single script

from pi_conf import set_config
cfg = set_config("ourappname")

print(cfg.foo) # 1
print(cfg.bar.a) # 2

Using inside of applications

The following is the preferred way of using the p-config module. We set it once in our __init__.py then use it whichever files need it. Since cfg is a singleton setting it multiple times is unnecessary and will cause it to load from the file again.

# __init__.py

from pi_conf import set_config
set_config("ourappname") ## Sets the config from the application <appname> directory
from pi_conf import cfg as cfg ## Allows the cfg to be importable from our app

Using the config in files

Once it the config has been set you can use it from any file doing either of the following methods.

• Option 1

from ourappname import cfg ## Import cfg from what we set in __init__.py

print(cfg.foo) # 1

• Option 2

from pi_conf import cfg ## Import the cfg from p-config

print(cfg.foo) # 1