Dynamic global and instance settings for your django project
exequiel09 and EliotBerriot Run makemigrations to add missing migrations file (#161)
Fixes #160. No tests were added since this is only adding migrations file.
Latest commit 66dcbfb Nov 22, 2018
Permalink
Type Name Latest commit message Commit time
Failed to load latest commit information.
docs Handle 'required' attribute for all inherited BasePreferenceType class ( Sep 21, 2018
dynamic_preferences Run makemigrations to add missing migrations file (#161) Nov 22, 2018
example Handle 'required' attribute for all inherited BasePreferenceType class ( Sep 21, 2018
tests add section filter in query string for DRF list endpoint (#154) Sep 21, 2018
.gitignore Feature localize dynamic prefrences (#159) Nov 18, 2018
.travis.yml Broken test matrix Jun 16, 2018
AUTHORS.rst Version bump and changelog Nov 3, 2017
CONTRIBUTING.rst Fixed minor typo / structure issues in readme / documentation Feb 12, 2016
HISTORY.rst Version bump and changelog for 1.7 Nov 18, 2018
LICENSE Now uses cookiecutter template for most things Jul 5, 2015
MANIFEST.in Feature localize dynamic prefrences (#159) Nov 18, 2018
Makefile Now uses cookiecutter template for most things Jul 5, 2015
README.rst Update README.rst (#147) Aug 10, 2018
pytest.ini Fixed #84: added documentation about form field override, and fixed a… Jul 30, 2017
requirements-docs.txt Removed django dependency in requirements.txt, moved it to requiremen… Jul 6, 2017
requirements-test.txt Should fix issue with test crashing because of bad DRF version (#107) Oct 14, 2017
requirements.txt Unsaved buffer, :sad: Jul 6, 2017
runtests.py Fix running tests with Django 1.10 Aug 22, 2016
setup.cfg Now uses cookiecutter template for most things Jul 5, 2015
setup.py Python 3.6 official support, drop support for django <1.11 Jun 15, 2018
tox.ini Broken test matrix Jun 16, 2018

README.rst

django-dynamic-preferences

https://badge.fury.io/py/django-dynamic-preferences.png https://readthedocs.org/projects/django-dynamic-preferences/badge/?version=latest https://travis-ci.org/EliotBerriot/django-dynamic-preferences.svg?branch=master https://travis-ci.org/EliotBerriot/django-dynamic-preferences.svg?branch=develop Backers on Open Collective Sponsors on Open Collective

Warning

There is a critical bug in version 1.2 that can result in dataloss. Please upgrade to 1.3 as soon as possible and do not use 1.2 in production. See #81 for more details.

Dynamic-preferences is a Django app, BSD-licensed, designed to help you manage your project settings. While most of the time, a settings.py file is sufficient, there are some situations where you need something more flexible such as:

  • per-user settings (or, generally speaking, per instance settings)
  • settings change without server restart

For per-instance settings, you could actually store them in some kind of profile model. However, it means that every time you want to add a new setting, you need to add a new column to the profile DB table. Not very efficient.

Dynamic-preferences allow you to register settings (a.k.a. preferences) in a declarative way. Preferences values are serialized before storage in database, and automatically deserialized when you need them.

With dynamic-preferences, you can update settings on the fly, through django's admin or custom forms, without restarting your application.

The project is tested and work under Python 2.7 and 3.4, 3.5 and 3.6, with django >=1.8.

Features

  • Simple to setup
  • Admin integration
  • Forms integration
  • Bundled with global and per-user preferences
  • Can be extended to other models if need (e.g. per-site preferences)
  • Integrates with django caching mechanisms to improve performance

Documentation

The full documentation is at https://django-dynamic-preferences.readthedocs.org.

Contributing

See http://django-dynamic-preferences.readthedocs.org/en/latest/contributing.html

Credits


Contributors


This project exists thanks to all the people who contribute!

https://opencollective.com/django-dynamic-preferences/contributors.svg?width=890&button=false

Backers


Thank you to all our backers! Become a backer.

https://opencollective.com/django-dynamic-preferences/backers.svg?width=890

Sponsors


Support us by becoming a sponsor. Your logo will show up here with a link to your website. Become a sponsor.