config-library 0.8.2

utility library to find and load configuration files

config-library

utility library to find and load configuration files

see the documentation for more information

• config-library
  • Installation
  • Supported Config-Types
  • Install Variations
  • More about configlib
    • Places to search for
  • Usage Example
    • Basic Usage
    • Loading specific file
    • Specify/Customise search locations
  • More in detail

Installation

• pip install config-library
• pip install config-library[all]
• pip install config-library[watcher]
• pip install config-library[json5]
• pip install config-library[toml]
• pip install config-library[yaml]

Supported Config-Types

extension	requires	link (for more information)
.ini/.conf/.config		https://en.wikipedia.org/wiki/INI_file
.json		https://en.wikipedia.org/wiki/JSON
.jsonc		https://changelog.com/news/jsonc-is-a-superset-of-json-which-supports-comments-6LwR
.json5	config-library[json5]	https://json5.org/
.toml	config-library[toml] or python3.11+	https://toml.io/
.yaml/.yml	config-library[yaml]	https://en.wikipedia.org/wiki/YAML
.xml		https://en.wikipedia.org/wiki/XML

Install Variations

variation	information
config-library[all]	adds all dependencies from the variations below
config-library[watcher]	adds support to watch the config-file for changes
config-library[json5]	adds support to load .json5 files
config-library[toml]	adds support to load .toml files
config-library[yaml]	adds support to load .yaml files

More about configlib

Places to search for

/path/to/your/source/code/
/path/to/your/git-repo/
/home/<user>/.config/
/home/<user>/
/etc/

Note: On Windows there are respective counterparts.

And in these folders it searches for either directly the config file or a sub-folder that's named like your project.

Usage Example

Basic Usage

from configlib import find_and_load

config = find_and_load("app.conf")
# config = find_and_load("app.json")  # format could be easily exchanged
# config = find_and_load("app.toml")  # depending on your needs and preferences
# config = find_and_load("app.yaml")  # and it should continue to work

address = config.get('database', 'address')
# address = config.getstr('database', 'address')  # also possible to ensure it's of type str
port = config.getint('database', 'port', fallback=5000)

Loading specific file

import configlib


config = configlib.load("./app.conf")

Specify/Customise search locations

from configlib.finder import find, places

config_file = find(
    name="app.conf",  # name of config-file is 'app.conf'
    places=[places.local, places.user_conf],  # search in main.py folder and ~/.config/
    namespace="myproject",
    ns_only=True,  # only search for 'myproject/app.conf' in places
)

More in detail

import configlib
config = configlib.find_and_load('app.conf', 'project')

system file-structure

/
├─ etc/
├─ home/user/
│  ├─ path/to/repo/
│  │  ├─ src/code/
│  │  │  ├─ main.py
│  ├─ .config/

places where config-library searches for the config-file

• /home/user/path/to/repo/src/code/app.conf
• /home/user/path/to/repo/src/code/project/app.conf
• /home/user/path/to/repo/app.conf
• /home/user/path/to/repo/project/app.conf
• /home/user/.config/app.conf
• /home/user/.config/project/app.conf
• /home/user/app.conf
• /home/user/project/app.conf
• /etc/app.conf
• /etc/project/app.conf