zettings

A configuration/settings utility that that exposes project settings as standard Python dictionaries.

zettings is a Python configuration library designed for simplicity. It loads settings data from TOML files and exposes them as standard Python dictionaries. This allows you to work with settings in a familiar, Pythonic way.

Table of Contents

• Features
• Install
• Usage
• Contributing
• License

Features

• TOML: Uses TOML under the hood for modern settings files.
• Dictionary: Access and change settings with regular dictionary operations.
• Nested Keys: Supports nested dictionary keys with dotted key notation.
• Optional defaults: Provide default values for initializing the settings file or for when a key is missing in the settings file.
• Optional always_reload: Reload the setting file everytime a key is read. (Enabled by default)
• Optional filepath: Provide the exact file Path of the .toml file to use. (overrides name)

Install

# PyPI
pip install zettings

or

uv add zettings

Dependencies

Python 3.9 or greater

Usage

Example

This will create/use a 'settings.toml' file located in the '.zettings' directory of the user's home directory.

from zettings import Settings

# Standard Dictionary Format
defaults = {
    "settings": {
        "name": "MyName",
        "mood": "happy",
    },
}
# Dotted Key Notation
defaults = {}
defaults["settings.name"] = "MyName"
defaults["settings.mood"] = "happy"

settings = Settings(".zettings/settings.toml", defaults) # Change 'zettings' to your project's name

print(settings["settings.mood"])
settings["settings.mood"] = "angry"
print(settings["settings.mood"])

Contributing

PRs accepted.

If editing the Readme, please conform to the standard-readme specification.

Bug Reports and Feature Requests

Please use the issue tracker to report any bugs or request new features.

Contributors

License

MIT © Nick Stuer