Skip to main content

A re-useable Django app for building models that modify Django settings.

Project description

Settings Model

TravisCI PyPI Coveralls Code Style

Documentation: https://django-settings-model.readthedocs.io

Source: https://github.com/gregschmit/django-settings-model

PyPI: https://pypi.org/project/django-settings-model/

This Django reusable app implements a base SettingsModel class to allow settings to be edited and saved in the database. For any particular project, you probably want to customize which settings are exposed, so while there is a Settings example implementation that you can use, the abstract model SettingsModel can be used to construct your own settings model(s), and things like webserver restarts are handled in the abstract model class.

The Problem: Sometimes you want to build an app that can be managed by non-developers, and things like timezone, hostname, or SMTP settings may need to be editable from the UI.

The Solution: This app implements a base SettingsModel class that allows you to expose settings to a user interface via the database. It writes these stub settings to separate files which you try/include at the end of your main settings file. This way you have sensible defaults, but when the user created/edits a model file in the UI, those settings override. There is a mechanism to touch the wsgi.py/manage.py files when saving, so the only thing left to do is either configure your web server to watch those files and reboot when they are touched, or use a tool like incrond to watch those files and trigger your webserver to reboot when they are touched.

How to Use

$ pip install django-settings-model

You can use the builtin Settings model by including this app (settings_model) in your INSTALLED_APPS and running migrations, or you can create your own custom settings model, inheriting from settings_model.base.SettingsModel. If you want to build a custom settings Model, use the Settings model as a reference implementation.

For the included Settings model, you need to add the following to the end of your settings.py file:

try:
    from .model_settings import *
except:
    pass

If you create a custom Settings model, then ensure you set the __settings_filename__ appropriately (avoid conflicts with other settings models), and ensure you call its .init() class method in the application’s AppConfig.ready() method. This will update the settings with the true values (and optionally create an initial settings model instance) on startup.

Settings

  • SETTINGS_MODEL_REBOOT_FILES (default []): This is a list of files that should be touched when the settings model is saved to signal to the webserver to reboot. If it is falsy, then the system will try to find and touch the file BASE_DIR/manage.py and the wsgi.py file defined by WSGI_APPLICATION.

Contributing

Submit a pull request if you would like to contribute. You must only contribute code that you have authored or otherwise hold the copyright to, and you must make any contributions to this project available under the MIT license.

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-settings-model-0.5.5.tar.gz (14.3 kB view details)

Uploaded Source

Built Distribution

django_settings_model-0.5.5-py3-none-any.whl (17.3 kB view details)

Uploaded Python 3

File details

Details for the file django-settings-model-0.5.5.tar.gz.

File metadata

  • Download URL: django-settings-model-0.5.5.tar.gz
  • Upload date:
  • Size: 14.3 kB
  • Tags: Source
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for django-settings-model-0.5.5.tar.gz
Algorithm Hash digest
SHA256 3cb7e9798009260125d4710b6c6246104fe0260f0b10c717ec6781e65378df09
MD5 2d284743618267a42d0f043e87014768
BLAKE2b-256 78eb7c816602a01ea770fe37a698657769f8af1e91fb862be687e928b794e925

See more details on using hashes here.

Provenance

File details

Details for the file django_settings_model-0.5.5-py3-none-any.whl.

File metadata

  • Download URL: django_settings_model-0.5.5-py3-none-any.whl
  • Upload date:
  • Size: 17.3 kB
  • Tags: Python 3
  • Uploaded using Trusted Publishing? No
  • Uploaded via: twine/1.12.1 pkginfo/1.4.2 requests/2.20.1 setuptools/40.5.0 requests-toolbelt/0.8.0 tqdm/4.28.1 CPython/3.7.1

File hashes

Hashes for django_settings_model-0.5.5-py3-none-any.whl
Algorithm Hash digest
SHA256 cf3f8ef86e2d3f4fba78a14ba662539304423bd48e8fbbf7fe947442fe2625c8
MD5 1594000789ca1ee20d546c32e1a7dcf9
BLAKE2b-256 7b211536d7b41caa78bbb2619ce49fea137793171dbc76a6044d96dfec4603cd

See more details on using hashes here.

Provenance

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page