app-settings-pydantic

app-settings-pydantic

A simple configuration management package using pydantic-settings and platformdirs.

This package allows you to define application settings in a .env file stored in the user's configuration directory.

Features

• Automatically determines the appropriate configuration file location using platformdirs
• Uses pydantic-settings for settings validation and management
• Supports configuration before use via the configure() function
• Provides a .save() method to persist settings

Installation

pip install app-settings-pydantic

Usage

1. Configure the app

Before using Settings, you must configure the package with app name and default language.

from app_settings import configure

configure(app_name="my_app", default_language="en")

2. Use the Settings class

from app_settings import Settings

settings = Settings()

3. Save settings

settings.language = "pl"
settings.save()  # Saves to ~/.config/my_app/.env (Linux)

Configuration Path

The configuration file is stored in the user config directory provided by platformdirs, e.g.:

• Linux: ~/.config/<app_name>/.env
• macOS: ~/Library/Application Support/<app_name>/.env
• Windows: C:\Users\<User>\AppData\Local\<app_name>\.env

Fields

Currently, the settings class includes:

• language: Application language (default from configure(), supports "en" and "pl")

Errors

If configure() is not called before accessing Settings, a RuntimeError will be raised.

License

MIT