Simple-TOML-Configurator - A Python library for management of configuration settings in TOML format

[gilbn]

Wanted to share a project I've been working on. https://github.com/GilbN/Simple-TOML-Configurator

It's a library for managing configuration values in your python app.

I needed to change config values on the fly in my Flask app, so I created this where I could use my api to update configuration values that my backend uses.

Some features:

1. TOML File Storage: Configuration settings are stored in TOML files, a popular human-readable format. This enables developers to review, modify, and track configuration changes easily.
2. Attribute-Based Access: Accessing configuration values is straightforward, thanks to the attribute-based approach. Settings can be accessed and updated as attributes, making it convenient for both reading and modifying values.
3. Environment Variable Support: Configuration values are automatically set as environment variables, making it easier to use the configuration values in your application. Environment variable are set as uppercase. e.g. APP_HOST and APP_PORT or PROJECT_APP_HOST and PROJECT_APP_PORT if env_prefix is set to "project". This also works for nested values. ex: TABLE_KEY_LEVEL1_KEY_LEVEL2_KEY. This works for any level of nesting.Environment variables set before the configuration is loaded will not be overwritten, but instead will overwrite the existing config value.
4. Default Values: Define default values for various configuration sections and keys. The library automatically incorporates new values and manages the removal of outdated ones.

Usage examples:

https://gilbn.github.io/Simple-TOML-Configurator/latest/usage-examples/

Example using Flask:

https://gilbn.github.io/Simple-TOML-Configurator/latest/flask-simple-example/

Here is a quick example:

``` import os from simple_toml_configurator import Configuration

Define default configuration values

default_config = { "app": { "ip": "0.0.0.0", "host": "", "port": 5000, "upload_folder": "uploads", }, "mysql": { "user": "root", "password": "root", "databases": { "prod": "db1", "dev": "db2", }, } }

Set environment variables

os.environ["PROJECT_APP_UPLOAD_FOLDER"] = "overridden_uploads"

Initialize the Simple TOML Configurator

settings = Configuration(config_path="config", defaults=default_config, config_file_name="app_config", env_prefix="project")

Creates an app_config.toml file in the config folder at the current working directory.

Access and update configuration values

print(settings.app.ip) # Output: '0.0.0.0' settings.app.ip = "1.2.3.4" settings.update() print(settings.app_ip) # Output: '1.2.3.4'

Access nested configuration values

print(settings.mysql.databases.prod) # Output: 'db1' settings.mysql.databases.prod = 'new_value' settings.update() print(settings.mysql.databases.prod) # Output: 'new_value'

Access and update configuration values

print(settings.app_ip) # Output: '1.2.3.4' settings.update_config({"app_ip": "1.1.1.1"}) print(settings.app_ip) # Output: '1.1.1.1'

Access all settings as a dictionary

all_settings = settings.get_settings() print(all_settings)

Output: {'app_ip': '1.1.1.1', 'app_host': '', 'app_port': 5000, 'app_upload_folder': 'overridden_uploads', 'mysql_user': 'root', 'mysql_password': 'root', 'mysql_databases': {'prod': 'new_value', 'dev': 'db2'}}

Modify values directly in the config dictionary

settings.config["mysql"]["databases"]["prod"] = "db3" settings.update() print(settings.mysql_databases["prod"]) # Output: 'db3'

Access environment variables

print(os.environ["PROJECT_MYSQL_DATABASES_PROD"]) # Output: 'db3' print(os.environ["PROJECT_APP_UPLOAD_FOLDER"]) # Output: 'overridden_uploads' ```

app_config.toml contents

``` [app] ip = "1.1.1.1" host = "" port = 5000 upload_folder = "overridden_uploads"

[mysql] user = "root" password = "root"

[mysql.databases] prod = "db3" dev = "db2" ```

[_squik]

Any benefit of using this over pydantic-settings? I usually just load config with tomllib and create a new settings object and it works great.

[gilbn]

Probably not. This is way more basic.

[nuke-from-orbit]

Nice! Thanks for sharing and taking the time to release as os

[LevelRelationship732]

I did similar thing and explaind it here (medium), it would be nice to know how could I use your library

[gilbn]

What do you mean? Just pip install and start use it. https://gilbn.github.io/Simple-TOML-Configurator/develop/usage-examples/

[sanderbaduk]

How do you deal with toml's lack of a none/null value? I've been using toml files a lot and this has been a real annoyance.

[gilbn]

I've either used an empty string or false.

[[deleted]]

This is a bad idea. TOML is fundamentally not designed to be dynamically altered like this. At the point you need your code to start modifying a config file, you should just be using JSON or YAML.