Setup

• install it via pip install django-admin-caching

• add it to your settings and it auto-registers itself

  settings.INSTALLED_APPS = [
     ...
     'django_admin_caching',
     ...
  ]

• configure the admins you want cached (see below for detail)

Configuring the admin

• to enable cahcing, the admin_caching_enabled attribute of the model’s admin class must be set to True. Note this means you might need to unregister the default admin and register your custom one for third party models (e.g.: django.contrib.auth.models.Group)

• the cache key by default is <admin class module name>.<admin class name>- <model class app label>.<model class name>-<model object pk>. This could be customized by adding a custom key method to the admin class that returns the string key for the model object part of the key - def admin_caching_key(self, obj)

  • if settings.USE_I18N (and settings.USE_L10N) are enabled, for each enabled setting, a prefix will be added to the above, e.g.: <language name>.<locale name>.<the key from above>

• on the admin level, the cache’s name can be specified through the admin_caching_cache_name attribute. If omitted, it defaults to default

• on the admin level, the cache’s timeout can be specified through the admin_caching_timeout_seconds attribute. If omitted, it defaults to the cache’s default_tiemout

Release Notes

• 0.1.2

  • if i18n/l10n is enabled, account for it in the cache prefix

• 0.1.1

  • allow specifying the cache timeout on the admin class

• 0.1.0 - initial release

  • supports Django 1.8, 1.9, 1.10 on python 2.7, 3.3, 3.4, and 3.5

  • supports the following configuration attributes on the admin class

    • admin_caching_enabled

    • admin_caching_cache_name

    • admin_caching_key for custom object cache key

Contributing

As an open source project, we welcome contributions.

The code lives on github.

sudo apt-get -y install software-properties-common
sudo add-apt-repository ppa:fkrull/deadsnakes
sudo apt-get update
for version in 3.3 3.5; do
  py=python$version
  sudo apt-get -y install ${py} ${py}-dev
done