fabiocaccamo/django-extra-settingsPublic

NotificationsYou must be signed in to change notification settings
Fork34
Star588

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

License

MIT license

588 stars 34 forks Branches Tags Activity

Star

Notifications

You must be signed in to change notification settings

Branches Tags

Folders and files

Name		Name	Last commit message	Last commit date
Latest commit History 342 Commits
.github		.github
extra_settings		extra_settings
tests		tests
.gitignore		.gitignore
.pre-commit-config.yaml		.pre-commit-config.yaml
CHANGELOG.md		CHANGELOG.md
CODE_OF_CONDUCT.md		CODE_OF_CONDUCT.md
LICENSE.txt		LICENSE.txt
MANIFEST.in		MANIFEST.in
README.md		README.md
SECURITY.md		SECURITY.md
pyproject.toml		pyproject.toml
requirements-test.txt		requirements-test.txt
requirements.txt		requirements.txt
runtests.py		runtests.py
setup.py		setup.py
tox.ini		tox.ini

Repository files navigation

django-extra-settings

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

Installation

Runpip install django-extra-settings
Addextra_settings tosettings.INSTALLED_APPS
Runpython manage.py migrate
Runpython manage.py collectstatic
Restart your application server
Just go to the admin where you cancreate,update anddelete your settings.

Usage

Settings

All these settings are optional, if not defined insettings.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 formatEXTRA_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 changelistEXTRA_SETTINGS_SHOW_NAME_PREFIX_LIST_FILTER=False

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

# the package name displayed in the adminEXTRA_SETTINGS_VERBOSE_NAME="Settings"

Celery

Warning

When usingCelery'sautodiscover_tasks withforce=True, it triggers an aggressive task discovery that accesses Django settings before they're fully initialized. This premature access preventsdjango-extra-settings from properly setting up its default configuration values. More infohere.

Admin

You can display the settings model admin in another installed app group by using theEXTRA_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 thequeryset_processor argument.

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

Admin advanced configuration example

In your custom appphotos.admin module:

fromextra_settings.adminimportregister_extra_settings_adminregister_extra_settings_admin(app=__name__,queryset_processor=lambdaqs:qs.filter(name__istartswith="PHOTOS_"),unregister_default=True,)

In your custom appvideos.admin module:

fromextra_settings.adminimportregister_extra_settings_adminregister_extra_settings_admin(app=__name__,queryset_processor=lambdaqs: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 usingsettings.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 theEXTRA_SETTINGS_CACHE_NAME setting.

Python

You cancreate,read,update anddelete 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

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

Read

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

Update

fromextra_settings.modelsimportSettingsetting_obj=Setting(name="SETTING_NAME",value_type=Setting.TYPE_BOOL,value=True,)setting_obj.value=Falsesetting_obj.save()

Delete

fromextra_settings.modelsimportSettingSetting.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 returnTrue, otherwise returningFalse orNone aValidationError 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 usingextra_settings.test.override_settings.

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

fromextra_settings.testimportoverride_settings# decorator@override_settings(SETTING_NAME_1="value for testing 1",SETTING_NAME_2="value for testing 2")deftest_with_custom_settings(self):pass# context managerdeftest_with_custom_settings(self):withoverride_settings(SETTING_NAME_1="value for testing 1",SETTING_NAME_2="value for testing 2"):pass

Testing

# clone repositorygit clone https://github.com/fabiocaccamo/django-extra-settings.git&&cd django-extra-settings# create virtualenv and activate itpython -m venv venv&&. venv/bin/activate# upgrade pippython -m pip install --upgrade pip# install requirementspip install -r requirements.txt -r requirements-test.txt# install pre-commit to run formatters and linterspre-commit install --install-hooks# run teststox# orpython runtests.py# orpython -m djangotest --settings"tests.settings"