InstallationΒΆ

To install basic PKonfig without YAML and TOML support, run:

pip install pkonfig

YAML files parsing is handled with PyYAML:

pip install pkonfig[yaml]

TOML files are handled with Tomli/Tomllib:

pip install pkonfig[toml]

And if both TOML and YAML are needed:

pip install pkonfig[toml,yaml]

To use PKonfig storages with pydantic-settings:

pip install pkonfig[pydantic]

This integration requires Python 3.10+ because pydantic-settings does.

For production no .env files are needed, but proper environment variables should be set. In case some of the required variables are missing, ConfigValueNotFoundError exception is raised while AppConfig instantiation.