django-extra-settings

config and manage typed extra settings using just the django admin.

Installation

Run pip install django-extra-settings
Add extra_settings to settings.INSTALLED_APPS
Run python manage.py migrate
Run python manage.py collectstatic
Restart your application server
Just go to the admin where you can create, update and delete your settings.

Usage

Settings

All these settings are optional, if not defined in settings.py the default values (listed below) will be used.

# the name of the installed app for registering the extra settings admin.
EXTRA_SETTINGS_ADMIN_APP = "extra_settings"

# the name of the cache to use, if not found the "default" cache will be used.
EXTRA_SETTINGS_CACHE_NAME = "extra_settings"

# a list of settings that will be available by default, each item must contain "name", "type" and "value".
# check the #types section to see all the supported settings types.
EXTRA_SETTINGS_DEFAULTS = [
    {
        "name": "SETTING_NAME",
        "type": "string",
        "value": "Hello World",
    },
    # ...
]

# if True, settings names will be forced to honor the standard django settings format
EXTRA_SETTINGS_ENFORCE_UPPERCASE_SETTINGS = True

# if True, the template tag will fallback to django.conf.settings,
# very useful to retrieve conf settings such as DEBUG.
EXTRA_SETTINGS_FALLBACK_TO_CONF_SETTINGS = True

# the upload_to path value of settings of type 'file'
EXTRA_SETTINGS_FILE_UPLOAD_TO = "files"

# the upload_to path value of settings of type 'image'
EXTRA_SETTINGS_IMAGE_UPLOAD_TO = "images"

# if True, settings name prefix list filter will be shown in the admin changelist
EXTRA_SETTINGS_SHOW_NAME_PREFIX_LIST_FILTER = False

# if True, settings type list filter will be shown in the admin changelist
EXTRA_SETTINGS_SHOW_TYPE_LIST_FILTER = False

# the package name displayed in the admin
EXTRA_SETTINGS_VERBOSE_NAME = "Settings"

Admin

You can display the settings model admin in another installed app group by using the EXTRA_SETTINGS_ADMIN_APP setting.

You can also have a more advanced control, by registering the settings admin with multiple installed apps and filtering each app settings using the queryset_processor argument.

⚠️ If you do either of the above, you must run migrations for each app that will display extra_settings model admin in its admin (because django creates migrations even for proxy models).

Admin advanced configuration example

In your custom app photos.admin module:

from extra_settings.admin import register_extra_settings_admin

register_extra_settings_admin(
    app=__name__,
    queryset_processor=lambda qs: qs.filter(name__istartswith="PHOTOS_"),
    unregister_default=True,
)

In your custom app videos.admin module:

from extra_settings.admin import register_extra_settings_admin

register_extra_settings_admin(
    app=__name__,
    queryset_processor=lambda qs: qs.filter(name__istartswith="VIDEOS_"),
    unregister_default=True,
)

By default the "extra_settings" app has its own admin app group.

Caching

You can customise the app caching options using settings.CACHES["extra_settings"] setting, otherwise the "default" cache will be used:

CACHES = {
    # ...
    "extra_settings": {
        "BACKEND": "django.core.cache.backends.locmem.LocMemCache",
        "TIMEOUT": 60,
    },
    # ...
}

By default the "extra_settings" cache is used, if you want to use another cache you can set it using the EXTRA_SETTINGS_CACHE_NAME setting.

Python

You can create, read, update and delete settings programmatically:

Types

This is the list of the currently supported setting types you may need to use:

Setting.TYPE_BOOL
Setting.TYPE_DATE
Setting.TYPE_DATETIME
Setting.TYPE_DECIMAL
Setting.TYPE_DURATION
Setting.TYPE_EMAIL
Setting.TYPE_FILE
Setting.TYPE_FLOAT
Setting.TYPE_IMAGE
Setting.TYPE_INT
Setting.TYPE_JSON
Setting.TYPE_STRING
Setting.TYPE_TEXT
Setting.TYPE_TIME
Setting.TYPE_URL

Create

from extra_settings.models import Setting

setting_obj = Setting(
    name="SETTING_NAME",
    value_type=Setting.TYPE_STRING,
    value="django-extra-settings",
)
setting_obj.save()

Read

from extra_settings.models import Setting

value = Setting.get("SETTING_NAME", default="django-extra-settings")

Update

from extra_settings.models import Setting

setting_obj = Setting(
    name="SETTING_NAME",
    value_type=Setting.TYPE_BOOL,
    value=True,
)
setting_obj.value = False
setting_obj.save()

Delete

from extra_settings.models import Setting

Setting.objects.filter(name="SETTING_NAME").delete()

Validators

You can define a custom validator for each setting:

Validators must be defined using full python path, eg. myapp.mymodule.my_validator.
Validators are called passing a single argument (the value of the setting) and if the value is valid, they should return True, otherwise returning False or None a ValidationError is raised.

Templates

You can retrieve settings in templates:

{% load extra_settings %}

{% get_setting 'SETTING_NAME' default='django-extra-settings' %}

Tests

You can override specific settings during tests using extra_settings.test.override_settings.

It can be used both as decorator and as context-manager:

from extra_settings.test import override_settings

# decorator
@override_settings(SETTING_NAME_1="value for testing 1", SETTING_NAME_2="value for testing 2")
def test_with_custom_settings(self):
    pass

# context manager
def test_with_custom_settings(self):
    with override_settings(SETTING_NAME_1="value for testing 1", SETTING_NAME_2="value for testing 2"):
        pass

Testing

# clone repository
git clone https://github.com/fabiocaccamo/django-extra-settings.git && cd django-extra-settings

# create virtualenv and activate it
python -m venv venv && . venv/bin/activate

# upgrade pip
python -m pip install --upgrade pip

# install requirements
pip install -r requirements.txt -r requirements-test.txt

# install pre-commit to run formatters and linters
pre-commit install --install-hooks

# run tests
tox
# or
python runtests.py
# or
python -m django test --settings "tests.settings"

License

Released under MIT License.

Supporting

⭐ Star this project on GitHub
Follow me on GitHub
💙 Follow me on Twitter
💰 Sponsor me on Github

fabiocaccamo/django-extra-settings

fabiocaccamo

Reviews

Repository Details