dworshak-config 0.2.6

Get and set two-key plaintext configuration values stored to JSON file path.

dworshak-config

dworshak-config is a lightweight library for managing nested JSON configurations. It serves as the standard storage backend for the Dworshak ecosystem, providing a stable way to persist non-sensitive application settings.

By decoupling storage from user interaction, dworshak-config ensures that your scripts can retrieve settings silently when they exist, leaving the "how to ask for them" to its sister package, dworshak-prompt.

Features

• Zero Dependencies: Pure Python standard library (json and pathlib).
• Service-Oriented: Organizes settings by service and item (e.g., config["postgres"]["port"]).
• Atomic Persistence: Automatically handles directory creation and pretty-printed JSON writes.
• Fail-Safe Loading: Gracefully handles corrupted or missing configuration files.

Installation

uv add dworshak-config
# or
pip install dworshak-config

Usage

Basic I/O

The DworshakConfig is the primary interface for reading and writing data.

from dworshak_config import DworshakConfig

# Uses default path: ~/.dworshak/config.json
cfg = DworshakConfig()

# Store a value
cfg.set_value("aws", "region", "us-east-1")

# Retrieve a value (returns None if missing)
region = cfg.get_value("aws", "region")
print(f"Targeting: {region}")

Custom Configuration Paths

Perfect for project-specific settings that shouldn't live in the global Dworshak folder.

from dworshak_config import DworshakConfig

# Point to a specific project file
project_cfg = DworshakConfig("./.my_project/config.json")
project_cfg.set_value("internal", "debug_mode", True)

The Ecosystem Integration

While dworshak-config handles the persistence, it is designed to be orchestrated by dworshak-prompt for interactive workflows.

# In your application using dworshak-prompt
from dworshak_prompt import Obtain

# This will:
# 1. Check ~/.dworshak/config.json for 'api_url'
# 2. If missing, prompt the user (Console/GUI/Web)
# 3. Save the answer back to config.json automatically
api_url = Obtain.config("my_service", "api_url")

Configuration Schema

Data is stored in a clean, human-readable nested JSON format:

{
    "aws": {
        "region": "us-east-1",
        "output": "json"
    },
    "rjn_api": {
        "base_url": "https://api.example.com"
    }
}

---

CLI

The dworshak layer is the intended primary CLI entry point, but the dworshak-config CLI can be used directly.

See the dworshak-config Typer CLI structure.

dworshak-config helptree

helptree is utility funtion for Typer CLIs, imported from the typer-helptree library.

• GitHub: https://github.com/City-of-Memphis-Wastewater/typer-helptree
• PyPI: https://pypi.org/project/typer-helptree/

---

Sister Projects in the Dworshak Ecosystem

• CLI/Orchestrator: dworshak
• Interactive UI: dworshak-prompt
• Secrets Storage: dworshak-secret
• Plaintext Pathed Configs: dworshak-config
• Classic .env Injection: dworshak-env

pipx install dworshak
pip install dworshak-secret
pip install dworshak-config
pip install dworshak-env
pip install dworshak-prompt