dj-toml-settings 0.1.0

Load Django settings from a TOML file

dj-toml-settings

Load Django settings from a TOML file

dj-toml-settings reads settings from a TOML file. By default, both pyproject.toml and django.toml files are parsed for settings in the [tool.django] namespace.

# pyproject.toml

[tool.django]
ALLOWED_HOSTS = [
  "127.0.0.1",
]

Features

Variables

Use ${SOME_VARIABLE_NAME} to use an existing setting as a value.

# pyproject.toml

[tool.django]
GOOD_IPS = ["127.0.0.1"]
ALLOWED_HOSTS = ${GOOD_IPS}

Apps

[tool.django.apps.{ANY_NAME_HERE}] sections of the TOML file can be used to group settings together. They can be named anything. They will override any settings in [tool.django].

# pyproject.toml

[tool.django]
ALLOWED_HOSTS = ["127.0.0.1"]

[tool.django.apps.tailwind-cli]
TAILWIND_CLI_USE_DAISY_UI = true
TAILWIND_CLI_SRC_CSS = ".django_tailwind_cli/source.css"

Environments

The [tool.django.envs.{ENVIRONMENT_NAME}] section of the TOML file will be used when {ENVIRONMENT_NAME} is set to the ENVIRONMENT environment variable. For example, ENVIRONMENT=production python manage.py runserver will load all settings in the [tool.django.envs.production] section. There settings will override any settings in [tool.django.apps.*] or [tool.django].

# pyproject.toml

[tool.django]
ALLOWED_HOSTS = ["127.0.0.1"]

[tool.django.envs.development]
ALLOWED_HOSTS = ["example.localhost"]

[tool.django.envs.production]
ALLOWED_HOSTS = ["example.com"]

Special operations

Path

Convert a string to a Path object. Handles relative paths based on the TOML file.

# pyproject.toml

[tool.django]
BASE_DIR = { path = "." }
PROJECT_DIR = { path = "./your_project_folder" }
REPOSITORY_DIR = { path = "./.." }

Environment Variable

Retrieve variables from the environment by using an env key. Specify an optional default key for a fallback value.

# pyproject.toml

[tool.django]
EMAIL_HOST_PASSWORD = { env = 'SECRET_PASSWORD' }
SECRET_KEY = { env = 'SECRET_KEY', default = 'this-is-a-secret' }

Arrays

Add items to an array by using the insert key.

# pyproject.toml

[tool.django]
ALLOWED_HOSTS = { insert = '127.0.0.1' }

Integration with Django

This will override any variables defined in settings.py with settings from the TOML files.

# settings.py
from pathlib import Path
from dj_toml_settings import configure_toml_settings

BASE_DIR = Path(__file__).resolve().parent.parent
...

configure_toml_settings(base_dir=BASE_DIR, data=globals())

Integration with nanodjango

# app.py
from pathlib import Path
from dj_toml_settings import get_toml_settings

base_dir = Path(__file__).resolve().parent
app = Django(**get_toml_settings(base_dir=base_dir))

...

Integration with coltrane

# app.py
from pathlib import Path
from django.core.management import execute_from_command_line
from dj_toml_settings import get_toml_settings
from coltrane import initialize

base_dir = Path(__file__).resolve().parent.parent
wsgi = initialize(**get_toml_settings(base_dir=base_dir))

if __name__ == "__main__":
    execute_from_command_line()

...

Precedence

This is the order that files and sections are parsed (by default). The later sections override the previous settings.

1. pyproject.toml -> [tool.django]
2. pyproject.toml -> [tool.django.apps.*]
3. pyproject.toml -> [tool.django.envs.*] that match ENVIRONMENT environment variable
4. django.toml -> [tool.django]
5. django.toml -> [tool.django.apps.*]
6. django.toml -> [tool.django.envs.*] that match ENVIRONMENT environment variable

Specify a TOML file

from pathlib import Path
from dj_toml_settings import get_toml_settings

base_dir = Path(__file__).resolve().parent
toml_settings = get_toml_settings(base_dir=base_dir, toml_settings_files=["custom-settings.toml"])
...

Test

• uv install pip install -e .[dev]
• just test

Inspiration

• django-pyproject
• django-settings-toml