django-configvars

Guide

  • Overview
    • What it does
    • Why use secret()
    • Core concepts
  • Installation
    • Package install
    • Basic Django setup
    • Optional initialization
  • Quickstart
    • Declare settings in settings.py
    • Local overrides
    • Environment overrides
    • Secrets with files (Swarm / Portainer)
  • Usage
    • Precedence
    • Regular configuration values
    • Secret values
    • Descriptions in dumps
    • Env prefixes
  • Handling Secrets
    • Overview
    • Recommended pattern
    • Runtime behavior
    • Security behavior
    • File validation for file_var
    • CLI masking
  • Management Command
    • Command name
    • Examples
    • Options
      • --changed
      • --defaults
      • --comments
    • Notes

Reference

  • API Reference
    • Module-level helpers
      • initialize(local_settings_module=None, env_prefix=None)
      • config(var, default=None, desc=None)
      • secret(var=None, default=None, desc=None, file_var=None, allow_multiline=False)
      • get_config_variables()
    • Casting helpers
      • as_bool(value)
      • as_list(value, separator=",")
    • Autodoc reference
      • initialize()
      • config()
      • as_bool()
      • as_list()
      • secret()
      • get_config_variables()
  • Versioned Documentation
    • Publishing model
    • URL layout
  • Development
    • Run docs locally
    • Release workflow
django-configvars
  • Search

© Copyright 2026, Marcin Nowak.

Built with Sphinx using a theme provided by Read the Docs.

Versions