django-app-parameter

User Guide

  • Django App Parameter
    • Quick Start
    • Problem
    • Features
    • Access Patterns
    • Data Types
      • Basic Types
      • Date/Time Types
      • Validated Types
      • Structured Types
    • Validators
    • Setters
    • Use Cases
    • Encryption
      • Setup
      • Usage
      • Notes
    • vs. Alternatives
      • vs. settings.py
      • vs. Env vars
    • Limits
    • Documentation
    • Info
  • Usage Guide
    • Access Patterns
      • Proxy (Recommended)
      • Direct Access
      • Parameter Object
    • Type Usage
      • STR (String)
      • INT (Integer)
      • FLT (Float)
      • DCL (Decimal)
      • BOO (Boolean)
      • DATE (Date)
      • DATETIME (Date and Time)
      • TIME (Time)
      • DURATION (Timedelta)
      • URL (Validated URL)
      • EMAIL (Validated Email)
      • PERCENTAGE (0-100 Float)
      • LIST (Comma-separated)
      • DICT (JSON Dictionary)
      • JSN (Any JSON)
      • PATH (File Path)
    • Modifying Parameters
      • Using set()
      • Using auto_cast
      • In Admin
    • Validators
      • Adding Validators
      • Built-in Validators
      • Custom Validators
      • Validator JSON Format
    • In Views
    • In Templates
    • Advanced Patterns
      • Caching
      • Default Values
      • Dynamic Feature Flags
    • Best Practices
    • Next
  • Forms
    • Résumé du système de formulaires
    • API principale
      • create_parameter_field(parameter, **kwargs) → forms.Field
    • Configuration par type
    • Exemple d’utilisation dans un formulaire custom
    • Extension du registre
    • Formulaires Admin fournis
  • Management Commands
    • dap_load
      • Syntax
      • Options
      • Examples
      • JSON Format
      • Fields
      • Type Codes
      • Validators
        • Built-in Validators
        • Custom Validators
      • Complete Examples
        • Tax Rate with Validators
        • Email with Validation
        • Launch Date
      • Use Cases
        • Initial Deployment
        • Environment Migration
    • dap_dump
      • Syntax
      • Arguments
      • Examples
      • Output Format
      • Use Cases
    • dap_rotate_key
      • Syntax
      • Options
      • Examples
      • Process
      • Backup File Format
      • Custom Backup Location
    • Next
  • FAQ
    • Installation
      • Requirements?
      • Uninstall?
    • Basic Usage
      • Create parameter?
      • Access parameter?
      • app_parameter.SLUG vs param.get()?
      • Check if exists?
      • Modify parameter?
    • Data Types
      • Supported types?
      • FLT vs DCL?
      • JSN vs DICT vs LIST?
      • DATE vs DATETIME vs TIME?
      • DURATION type?
      • PERCENTAGE type?
      • PATH type?
    • Validators
      • What are validators?
      • Add validator?
      • Built-in validators?
      • Custom validators?
      • Validators in JSON?
      • Remove validators?
    • Slug System
      • What’s a slug?
      • Custom slug?
      • Slug collision?
      • Modify slug after creation?
    • Templates
      • Access in templates?
      • Why is_global?
    • Management Commands
      • Import many parameters?
      • Avoid overwriting?
      • Export parameters?
    • Performance
      • DB query per access?
      • How many params recommended?
    • Security
      • Store passwords?
      • Store API keys?
      • What’s safe to store?
    • Admin
      • Change parameter type?
      • Validators in admin?
      • Admin validation?
    • Advanced
      • Modify in code?
      • Delete parameter?
      • Default value on missing?
      • Type conversion errors?
      • Multi-tenant?
    • Troubleshooting
      • ImproperlyConfigured: SLUG parameters need to be set
      • ValueError: invalid literal for int()
      • ValidationError on save
      • Template variable not found
      • Migration errors
      • Admin doesn’t show
      • Validator not found
    • vs. Alternatives
      • vs. django-constance?
      • vs. settings.py?
      • vs. Environment variables?
    • Next

API Reference

  • API Reference
    • Models
      • ParameterValueTypeError
      • Parameter
        • Parameter.objects
        • Parameter.name
        • Parameter.slug
        • Parameter.value_type
        • Parameter.description
        • Parameter.value
        • Parameter.is_global
        • Parameter.enable_cypher
        • Parameter.enable_history
        • Parameter.from_db()
        • Parameter.type
        • Parameter.get_type()
        • Parameter.save()
        • Parameter.get()
        • Parameter.set()
        • Parameter.to_dict()
        • Parameter.from_dict()
        • Parameter.__str__()
        • Parameter.DoesNotExist
        • Parameter.MultipleObjectsReturned
        • Parameter.get_value_type_display()
        • Parameter.history
        • Parameter.id
        • Parameter.validators
      • ParameterValidator
        • ParameterValidator.parameter
        • ParameterValidator.validator_type
        • ParameterValidator.validator_params
        • ParameterValidator.get_validator()
        • ParameterValidator.__str__()
        • ParameterValidator.DoesNotExist
        • ParameterValidator.MultipleObjectsReturned
        • ParameterValidator.id
        • ParameterValidator.objects
        • ParameterValidator.parameter_id
      • ParameterHistory
        • ParameterHistory.parameter
        • ParameterHistory.value
        • ParameterHistory.modified_at
        • ParameterHistory.__str__()
        • ParameterHistory.DoesNotExist
        • ParameterHistory.MultipleObjectsReturned
        • ParameterHistory.get_next_by_modified_at()
        • ParameterHistory.get_previous_by_modified_at()
        • ParameterHistory.id
        • ParameterHistory.objects
        • ParameterHistory.parameter_id
      • ParameterInt
        • ParameterInt.type
        • ParameterInt.DoesNotExist
        • ParameterInt.MultipleObjectsReturned
      • ParameterStr
        • ParameterStr.DoesNotExist
        • ParameterStr.MultipleObjectsReturned
      • ParameterFloat
        • ParameterFloat.type
        • ParameterFloat.DoesNotExist
        • ParameterFloat.MultipleObjectsReturned
      • ParameterDecimal
        • ParameterDecimal.type
        • ParameterDecimal.DoesNotExist
        • ParameterDecimal.MultipleObjectsReturned
      • ParameterJson
        • ParameterJson.type
        • ParameterJson.DoesNotExist
        • ParameterJson.MultipleObjectsReturned
      • ParameterBool
        • ParameterBool.type
        • ParameterBool.FALSY_VALUES
        • ParameterBool.DoesNotExist
        • ParameterBool.MultipleObjectsReturned
      • ParameterDate
        • ParameterDate.type
        • ParameterDate.DoesNotExist
        • ParameterDate.MultipleObjectsReturned
      • ParameterDatetime
        • ParameterDatetime.type
        • ParameterDatetime.DoesNotExist
        • ParameterDatetime.MultipleObjectsReturned
      • ParameterTime
        • ParameterTime.type
        • ParameterTime.DoesNotExist
        • ParameterTime.MultipleObjectsReturned
      • ParameterUrl
        • ParameterUrl.type
        • ParameterUrl.DoesNotExist
        • ParameterUrl.MultipleObjectsReturned
      • ParameterEmail
        • ParameterEmail.type
        • ParameterEmail.DoesNotExist
        • ParameterEmail.MultipleObjectsReturned
      • ParameterList
        • ParameterList.type
        • ParameterList.DoesNotExist
        • ParameterList.MultipleObjectsReturned
      • ParameterDict
        • ParameterDict.type
        • ParameterDict.DoesNotExist
        • ParameterDict.MultipleObjectsReturned
      • ParameterPath
        • ParameterPath.type
        • ParameterPath.DoesNotExist
        • ParameterPath.MultipleObjectsReturned
      • ParameterDuration
        • ParameterDuration.type
        • ParameterDuration.DoesNotExist
        • ParameterDuration.MultipleObjectsReturned
      • ParameterPercentage
        • ParameterPercentage.type
        • ParameterPercentage.DoesNotExist
        • ParameterPercentage.MultipleObjectsReturned
      • Parameter Model
        • Parameter
      • ParameterValidator Model
        • ParameterValidator
      • ParameterHistory Model
        • ParameterHistory
    • Admin
    • Forms
      • Usage in a custom form
      • Usage with a single parameter
      • FieldConfig
        • FieldConfig.field_class
        • FieldConfig.widget
        • FieldConfig.extra_kwargs
        • FieldConfig.help_text
        • FieldConfig.field_class
        • FieldConfig.widget
        • FieldConfig.extra_kwargs
        • FieldConfig.help_text
        • FieldConfig.__init__()
      • get_field_config_for_type()
      • create_parameter_field()
      • ParameterCreateForm
        • ParameterCreateForm.Meta
        • ParameterCreateForm.__init__()
        • ParameterCreateForm.base_fields
        • ParameterCreateForm.declared_fields
        • ParameterCreateForm.media
      • ParameterEditForm
        • ParameterEditForm.Meta
        • ParameterEditForm.clean_value()
        • ParameterEditForm.base_fields
        • ParameterEditForm.declared_fields
        • ParameterEditForm.media
      • ParameterValidatorForm
        • ParameterValidatorForm.Meta
        • ParameterValidatorForm.__init__()
        • ParameterValidatorForm.clean_validator_type()
        • ParameterValidatorForm.base_fields
        • ParameterValidatorForm.declared_fields
        • ParameterValidatorForm.media
      • FieldConfig
        • FieldConfig
      • create_parameter_field
        • create_parameter_field()
      • ParameterCreateForm
        • ParameterCreateForm
      • ParameterEditForm
        • ParameterEditForm
      • ParameterValidatorForm
        • ParameterValidatorForm
    • Utilities
      • parameter_slugify()
      • get_setting()
      • import_validator()
      • get_validator_from_registry()
      • get_available_validators()
      • clear_validator_cache()
      • get_encryption_key()
      • encrypt_value()
      • decrypt_value()
    • Context Processors
      • add_global_parameter_context()
    • Management Commands
      • dap_load
        • Command
      • dap_dump
        • Command
      • dap_rotate_key
        • Command
    • AccessParameter Proxy
      • AccessParameter
        • AccessParameter.__getattr__()

Development

  • Changelog
    • Changelog
      • [3.1.0] - 2026.01.26
        • Changed:
      • [3.0.1] - 2026.01.20
      • [3.0.0] - 2026.01.20
        • Added
        • Changed
        • Added
      • [2.1.3] - 2025.11.15
        • Fixed
      • [2.1.2] - 2025.11.15
        • Changed
      • [2.1.1] - 2025.11.15
        • Fixed
      • [2.1.0] - 2025.11.15
        • Added
        • Changed
      • [2.0.0] - 2025.11.14
        • Added
        • Changed
        • Fixed
      • [1.1.3] - 2023.10.18
        • Added
        • Fixed
      • [0.2.0] -
        • Added
      • [0.1.3] - 2022-02-23
        • Added
        • Changed
  • Contributing
    • Contributing Guide
      • Prerequisites
      • Tested Versions
      • Development Environment Setup
      • Checklist Before Submitting a PR
        • Use Tox for complete testing
      • Code Standards
        • Code Style
        • Tests
        • Testing Configuration
        • Documentation
      • Project Structure
      • Types of Accepted Contributions
      • Manual Testing with Demo Project
        • Quick Start
        • Important Notes
      • Resources
      • Questions?
      • License
django-app-parameter
  • Overview: module code

All modules for which code is available

  • django_app_parameter
    • django_app_parameter.context_processors
    • django_app_parameter.forms
    • django_app_parameter.management.commands.dap_dump
    • django_app_parameter.management.commands.dap_load
    • django_app_parameter.management.commands.dap_rotate_key
    • django_app_parameter.models
    • django_app_parameter.utils

© Copyright 2026, Swann Bouvier-Muller.

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