Skip to main content

Display django permissions in a tabular format that is user friendly, and highly customisable

Project description

Display model permissions in a tabular widget that is user friendly, translatable and customizable. Scroll down for screen shots

Version

2.1 (July 16 2018)

Features:

  • Permissions and their relevant app and models names are displayed in the active language.
  • Permissions are displayed in a table that contain the default model permissions plus any custom permissions.
  • Customize which apps, models to show in the permissions table. You can also set a exclude function for high-end customization.
  • RTL ready, Bootstrap ready.
  • Easy customize-able look.
  • Django >= 1.11
  • Tested on Python 2.7, 3.5, 3.6 & 3.7, Django 1.11 & 2.0.
  • Default FilteredSelectMultiple widget will appear only if you have custom permissions that are not model related (ie directly created by code or hand)
https://travis-ci.org/RamezIssac/django-tabular-permissions.svg?branch=master

Installation

You can install django-tabular-permissions via Pypi:

pip install django-tabular-permissions

and add “tabular_permissions” to your INSTALLED_APPS setting (at any place after django.contrib.auth)

INSTALLED_APPS = [
    'django.contrib.auth',
     ....
    'tabular_permissions',
]

then navigate to User and/or Group change form to see tabular_permissions in action.

Configuration:

Tabular_permissions possible configurations and their default:

TABULAR_PERMISSIONS_CONFIG = {
    'template': 'tabular_permissions/admin/tabular_permissions.html',
    'exclude': {
        'override': False,
        'apps': [],
        'models': [],
        'function':'tabular_permissions.helpers.dummy_permissions_exclude'
    },
    'auto_implement': True,
    'use_for_concrete': True,
    'custom_permission_translation': 'tabular_permissions.helpers.custom_permissions_translator',
    'apps_customization_func': 'tabular_permissions.helpers.apps_customization_func',
}
template
the template which contains the permissions table, you can always customize this template by extending or overriding
exclude

Control which apps, models to show in the permissions table.

By default tabular_permissions exclude sessions , contenttypes and admin apps from showing their models in the permissions table. If you want to show them you can switch override to False.

apps & models lists would contain the names of the apps and models you wish to exclude.

function is a dotted path of a custom function which receive the model as a parameter to decide either to exclude it or not, default to a dummy function that always return False (ie do not exclude)

auto_implement

By default, just by including tabular_permissions in your installed_apps, the django.contrib.admin.UserAdmin (and GroupAdmin) are “patched” to include the tabular_permissions widget. If you have a custom UserAdmin, then set this option to False and make sure you either:

  1. Inherit from tabular_permissions.admin.TabularPermissionsUserAdmin and tabular_permissions.admin.TabularPermissionsGroupAdmin for User & Group ModelAdmin.
  2. Or for a more direct and compact way, inherit your ModelAdmin from tabular_permissions.admin.UserTabularPermissionsMixin and tabular_permissions.admin.GroupTabularPermissionsMixin (comes before admin.ModelAdmin in the mro),
  3. Set the user_permissions widget to tabular_permissions.widgets.TabularPermissionsWidget and remember to send a 3rd argument ‘permissions’ for Group Model Admin. See tabular_permissions.admin for information.
use_for_concrete

There is an inconsistency with proxy models permissions (Django ticket 11154).

So in case you have proxy models and you created their permissions by hand (via this gist maybe), then turn off this option in order to correctly assign your newly created permissions.

custom_permission_translation
A dotted path function to translate the custom permission. This function gets passed the permissions codename, verbose_name and its relevant content_type_id. The function will try to translate the permission verbose_name.
apps_customization_func
A dotted path function to control the whole permissions objects passed to the widget. Sometimes you use custom menu where apps and models are ordered in a more “user friendly” manner and not necessarily in the “actual programmatic” apps & models order. You can use this option to get a hold of the whole ordered dict and shuffle its content around moving models from one app to the other and do all kind of crazy stuff to get just the right table of permissions.

JavaScript:

Located at ‘static/tabular_permissions/tabular_permissions.js’, it have 2 responsibilities:

  1. Upon form submit, the checked permissions in the table are dynamically appended to the form default permission input so the backend can carry on its functionality normally and correctly.
  2. Add handlers for column and row select-all checkboxes.

Compatibility:

Current version 2.0 supports only Django >= 1.11 For earlier versions of django use django-tabular-permissions 1.0.9.

Screenshots:

Basic Demo

Basic demo

RTL and localized

RTL and localized

With Custom permission behaviour

With Custom permission

Enjoy and feel free to report any bugs or make pull requests.

Cheers ;-)

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Filename, size & hash SHA256 hash help File type Python version Upload date
django-tabular-permissions-2.1.tar.gz (10.5 kB) Copy SHA256 hash SHA256 Source None

Supported by

Elastic Elastic Search Pingdom Pingdom Monitoring Google Google BigQuery Sentry Sentry Error logging AWS AWS Cloud computing DataDog DataDog Monitoring Fastly Fastly CDN SignalFx SignalFx Supporter DigiCert DigiCert EV certificate StatusPage StatusPage Status page