openwisp-utils 0.1.0a0

Adding admin theme

For using the customized admin theme,

• Make sure you’ve added openwisp_utils.admin_theme to INSTALLED_APPS in settings.py

• Add the following into your urls.py file which contains admin urls.

from django.conf.urls import include, url

from openwisp_utils.admin_theme.admin import admin, openwisp_admin

openwisp_admin()

urlpatterns = [
    # other url patterns
    url(r'^admin/', include(admin.site.urls)),
]

Using Multitenant and other admin mixins

These are mixins which make a ModelAdmin class multitenant: users will see only the objects related to the organizations they are associated with.

• MultitenantAdminMixin: inheriting this class would make a ModelAdmin class multitenant. set multitenant_shared_relations to the list of parameters you wish to have only organization specific options.

• MultitenantObjectFilter: Admin filter that shows only organizations the current user is associated with in its available choices.

• MultitenantObjectFilter: Admin filter that shows only objects of organizations the current user is associated with.

• TimeReadonlyAdminMixin: Admin mixin which adds two readonly fields created and modified. This is an admin mixin for models inheriting TimeStampedEditableModel which adds the fields created and modified to the database.

from django.contrib import admin

from openwisp_utils.admin import (MultitenantAdminMixin,
                                  MultitenantObjectFilter,
                                  MultitenantOrgFilter,
                                  TimeReadonlyAdminMixin)

from .models import Book, Shelf


class BaseAdmin(MultitenantAdminMixin, TimeReadonlyAdminMixin, admin.ModelAdmin):
    pass


class ShelfAdmin(BaseAdmin):
    list_display = ['name', 'organization']
    list_filter = [('organization', MultitenantOrgFilter)]
    fields = ['name', 'organization', 'created', 'modified']


class BookAdmin(BaseAdmin):
    list_display = ['name', 'author', 'organization', 'shelf']
    list_filter = [('organization', MultitenantOrgFilter),
                   ('shelf', MultitenantObjectFilter)]
    fields = ['name', 'author', 'organization', 'shelf', 'created', 'modified']
    multitenant_shared_relations = ['shelf']

Using DependencyLoader and DependencyFinder

Add the list of all packages extended to EXTENDED_APPS in settings.py. If you’ve extended django_netjsonconfig and django_x509:

EXTENDED_APPS = ['django_netjsonconfig', 'django_x509']

• DependencyFinder: Add openwisp_utils.staticfiles.DependencyFinder to STATICFILES_FINDERS in settings.py.

STATICFILES_FINDERS = [
    'django.contrib.staticfiles.finders.FileSystemFinder',
    'django.contrib.staticfiles.finders.AppDirectoriesFinder',
    'openwisp_utils.staticfiles.DependencyFinder',
]

• DependencyLoader: Add openwisp_utils.staticfiles.DependencyFinder to TEMPLATES_LOADERS in settings.py or as shown below.

TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [],
        'OPTIONS': {
            'loaders': [
                'django.template.loaders.filesystem.Loader',
                'django.template.loaders.app_directories.Loader',
                'openwisp_utils.loaders.DependencyLoader',
            ],
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]