Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/jqb/django-settings
Application to keep simple settings in database. Based on the contenttype framework.
https://github.com/jqb/django-settings
Last synced: 30 days ago
JSON representation
Application to keep simple settings in database. Based on the contenttype framework.
- Host: GitHub
- URL: https://github.com/jqb/django-settings
- Owner: jqb
- License: bsd-3-clause
- Created: 2010-07-12T14:50:39.000Z (over 14 years ago)
- Default Branch: master
- Last Pushed: 2021-06-10T17:31:09.000Z (over 3 years ago)
- Last Synced: 2024-11-02T21:51:34.459Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 108 KB
- Stars: 83
- Watchers: 4
- Forks: 47
- Open Issues: 13
-
Metadata Files:
- Readme: README.rst
- License: LICENSE
Awesome Lists containing this project
README
django-settings
===============
.. image:: https://badge.fury.io/py/django-settings.png
:target: https://badge.fury.io/py/django-settings
.. image:: https://api.travis-ci.org/jqb/django-settings.png?branch=master
:target: https://travis-ci.org/jqb/django-settings
Django reusable application for storing global project settings in database.
By project settings I mean things like admin mail, some default values like
default_post_limit etc. Values are validated depending their type.
Begining with ver 1.3 you can register your own settings values.
Supported versions
------------------
* Python: 2.6, 2.7 (python 2.6 requires importlib)
* Django: 1.3, 1.4, 1.5
API
---
IMPORTANT: changed in version 1.3, old api still works but caching do not work with it.
.. code-block:: python
import django_settings
# getting values
# this will raise django_settings.models.Setting.DoesNotExist
# exception if value not exists
# if value is not in cache it will be cached
django_settings.get('post_limit')
# if you not sure value exists you can pass "default" parameter,
# at this point default is NOT cached
django_settings.get('post_limit', default=10)
# set values - cache is updated for "get" and "exists" method
# values are validated using setting_value model clean_fields method
django_settings.set('Email', 'admin_email', '[email protected]')
# If you want to avoid validation, do this:
django_settings.set('Email', 'admin_email', '[email protected]', validate=False)
# checking if value exists
django_settings.exists('admin_email')
# getting all values as a dict
django_settings.all()
Or in templates
.. code-block:: python
{% load settings_tags %}
Current post limit is {% settings "post_limit" %}
or
{% settings "post_limit" as post_limit %}
Current post limit is {{ post_limit }}
Installation & setup
--------------------
1) Install it using pip:
.. code-block:: bash
$> pip install django-settings
2) Add "django_settings" to your INSTALLED_APPS
.. code-block:: python
INSTALLED_APPS = (
'django.contrib.contenttypes', # contenttypes framework is required
# ...
'django_settings',
# ...
)
3) If you want to add your own settings models, please add them in one of your
applications models file, and register them with django_settings api:
.. code-block:: python
# //models.py
from django.db import models
# ... your application models
import django_settings
class Text(django_settings.db.Model):
value = models.TextField()
class Meta:
abstract = True # it's IMPORTANT - it need to be abstract
django_settings.register(Text)
Remember to define model as abstract, this is important because of how django
treats model classes.
There is ability to setup some defaults via project settings.py file.
Those settings will be setup ONLY if they not already exists in db.
.. code-block:: python
DJANGO_SETTINGS = {
'application_limit': ('Integer', 2),
'admin_email': ('String', '[email protected]'),
}
For import DJANGO_SETTINGS into database use command:
.. code-block:: python
./manage.py settings_initialize
Default django-settings timeout is set to 1 day, but it can be changed
in your project settings:
.. code-block:: python
DJANGO_SETTINGS_TIMEOUT = 60 * 60 * 10 # 10 hours
Timeout let's you define cache timeout (in sec.) for each of the
settings. After the given time values gets expired and each of them
will be recalculated (at the moment you ask for the given
setting). Introduced due to django's defaults cache timeout (5 min):
https://docs.djangoproject.com/en/dev/topics/cache/#cache-arguments
Settings types
--------------
Builidin settings types: Email, Integer, String, PositiveInteger
Admin
-----
You can manipulate setting via your admin interface.
Changelog
---------
1.3.12 - post sync db settings initialization fixed
- initial signal moved to models
1.3-11 - several bug fixes
- "Clear cache for settings" admin action exception fixed [#12]
- admin setting edition cache update bug fixed
- "syncdb" signal callback is now fixed so it won't "reinit" settings on every syncdb [#14]
1.3-8 - DJANGO_SETTINGS_TIMEOUT fix
- it's now cofigurable through project settings
1.3-7 - several improvements and bug fix
- "all" function added
- admin setting add/edit callback: "DataAPI._set_cache_for" bug fix.
- settings timeout customization added (default to 1 day)
1.3-4 - setup.py bug fix
1.3-3 beta - python & django various versions compatibility changes
1.3-2 beta - several bug fixes including cache unicode keys handling, tests added
1.3-1 beta - admin render_change_form fix
1.3 beta - several improvements has been made since ver 1.0
1) setting name need to be unique now (backward incompatiblity)
2) from now you can extend settings with your own types using
`django_settings.register` function
3) new api with caching mechanism introduced
4) admin interface has been improved, action to clear cache
keys only used by the package added
Some tests has been added for core functionality.
Backward incompatible changes
`django_settings.models.Setting` name need to be unique now, however
ver 1.3 still allows it to not to be unique. Just set `DJANGO_SETTINGS_UNIQUE_NAMES`
application setting to False (True is by default).
Author
------
* Kuba Janoszek ([email protected])
Contributors
------------
* `Trey Hunner `_
* `ygneo `_
* `bsavelev `_
* `akolpakov `_