Skip to main content

Dynamic global and instance settings for your django project

Project description

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

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, with django 1.7 and 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.

Changelog

0.5.4 (06-09-2015)

  • Merged PR #16 that fix a typo in the code

0.5.3 (24-08-2015)

  • Added switch for list_editable in admin and warning in documentation, fix #14

  • Now use Textarea for LongStringPreference, fix #15

0.5.2 (22-07-2015)

  • Fixed models not loaded error

0.5.1 (17-07-2015)

  • Fixed pip install (#3), thanks @willseward

  • It’s now easier to override preference form field attributes on a preference (please refer to Preferences attributes for more information)

  • Cleaner serializer api

0.5 (12-07-2015)

This release may involves some specific upgrade steps, please refer to the Upgrade section of the documentation.

0.5 (12-07-2015)

This release may involves some specific upgrade steps, please refer to the Upgrade section of the documentation.

  • Migration to CharField for section and name fields. This fix MySQL compatibility issue #2

  • Updated example project to the 0.4 API

0.4.2 (05-07-2015)

  • Minor changes to README / docs

0.4.1 (05-07-2015)

  • The cookiecutter part was not fully merged

0.4 (05-07-2015)

  • Implemented cache to avoid database queries when possible, which should result in huge performance improvements

  • Whole API cleanup, we now use dict-like objects to get preferences values, which simplifies the code a lot (Thanks to Ryan Anguiano)

  • Migrated the whole app to cookiecutter-djangopackage layout

  • Docs update to reflect the new API

0.3.1 (10-06-2015)

  • Improved test setup

  • More precise data in setup.py classifiers

0.2.4 (14-10-2014)

  • Added Python 3.4 compatibility

0.2.3 (22-08-2014)

  • Added LongStringPreference

0.2.2 (21-08-2014)

  • Removed view that added global and user preferences to context. They are now replaced by template context processors

0.2.1 (09-07-2014)

  • Switched from GPLv3 to BSD 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-dynamic-preferences-0.5.4.tar.gz (19.0 kB view details)

Uploaded Source

File details

Details for the file django-dynamic-preferences-0.5.4.tar.gz.

File metadata

File hashes

Hashes for django-dynamic-preferences-0.5.4.tar.gz
Algorithm Hash digest
SHA256 7d4e6378a27033d747dc03a8ce2799fb8b0e1a85f80ae7f838f20247b8661877
MD5 dd99aa6be29cf1ab31e66484fb2d6c83
BLAKE2b-256 9486f4a82c93dc2ad78eb03adf1d0509b7a2fd73856405a23e92357594480b36

See more details on using hashes here.

Supported by

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