https://github.com/praekelt/django-preferences

Django app allowing users to set app specific preferences through the admin interface.
https://github.com/praekelt/django-preferences

django django-application python

Last synced: 2 months ago
JSON representation

Django app allowing users to set app specific preferences through the admin interface.

• Host: GitHub
• URL: https://github.com/praekelt/django-preferences
• Owner: praekelt
• License: bsd-3-clause
• Created: 2010-05-07T12:09:35.000Z (over 14 years ago)
• Default Branch: develop
• Last Pushed: 2018-12-20T12:48:06.000Z (almost 6 years ago)
• Last Synced: 2024-09-28T16:23:43.443Z (3 months ago)
• Topics: django, django-application, python
• Language: Python
• Homepage:
• Size: 63.5 KB
• Stars: 58
• Watchers: 13
• Forks: 16
• Open Issues: 4
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG.rst
  • License: LICENSE

Awesome Lists containing this project

README

        
Django Preferences

==================

**Django app allowing users to set app specific preferences through the admin interface.**

.. image:: https://travis-ci.org/praekelt/django-preferences.svg?branch=develop

    :target: https://travis-ci.org/praekelt/django-preferences

.. image:: https://coveralls.io/repos/github/praekelt/django-preferences/badge.svg?branch=develop

    :target: https://coveralls.io/github/praekelt/django-preferences?branch=develop

.. image:: https://badge.fury.io/py/django-preferences.svg

    :target: https://badge.fury.io/py/django-preferences

Provides singleton admin views for Preferences objects and a simple interface to preference values.

Singleton views ensure only one preference instance per site is available for each ``Preferences`` class.

..

    **Requires** and supports `Django's "sites" framework `_, which means you can have multiple preferences, each associated with a particular site.

.. contents:: Contents

    :depth: 5

Requirements

------------

#. Python 2.7, 3.5-3.7

#. Django 1.11, 2.0, 2.1

#. django.contrib.sites

Installation

------------

#. Install or add ``django-preferences`` to your Python path.

#. Add ``preferences`` to your ``INSTALLED APPS`` setting.

#. Add ``django.contrib.sites`` to your ``INSTALLED APPS`` setting. django-preferences associates preferences to specific sites and thus requires Django's "sites" framework to be installed.

#. Optionally, add ``preferences.context_processors.preferences_cp`` to your template option settings. This will automatically add a ``preferences`` variable to your template context::

     TEMPLATES = [{

         ...

         'OPTIONS': {

             'context_processors': [

                 ...

                 'preferences.context_processors.preferences_cp',

             ],

         },

     }]

Usage

-----

To create preferences for your app create a Django ORM model as usual, with the model inheriting from ``preferences.models.Preferences``. Also specify ``preferences.models`` as your model's module::

    from django.db import models

    from preferences.models import Preferences

    class MyPreferences(Preferences):

        portal_contact_email = models.EmailField()

Admin classes are specified as per usual, except that they have to inherit from or be registered with ``preferences.admin.PreferencesAdmin``, i.e.::

    from django.contrib import admin

    from preferences.admin import PreferencesAdmin

    from .models import MyPreferences

    admin.site.register(MyPreferences, PreferencesAdmin)

When your model is registered with admin it will show up under the *Preferences* app label in Django admin.

Preferences can be accessed in Python by importing the ``preferences`` module and traversing to your required preference in the form ``preferences..``, i.e.::

    from preferences import preferences

    portal_contact_email = preferences.MyPreferences.portal_contact_email

If you've specified the ``preferences.context_processors.preferences_cp`` as a `TEMPLATES `_ you can similarly access your preferences within templates through the ``preferences`` variable, i.e.::

    {{ preferences.MyPreferences.portal_contact_email }}