Django User Roles

Simple role-based user permissions for Django.

django-user-roles is a simple, reusable app that allows you to create a set of user roles, which can be used to control which views each type of user has permission to view, and to customize how the site is presented to different types of user.

Install

pip install custom-user-roles

Basic Usage

Settings

Add userroles do INSTALLED_APPS

INSTALLED_APPS = (
    ...
    'userroles',
)

Add the USER_ROLES setting

USER_ROLES = (
    'manager',
    'moderator',
    'client',
)

Define your Custom User model (optional)

AUTH_USER_MODEL = 'custom_user.EmailUser'

Tip: check this app to easily make your own custom user model

Add subroles for any of the roles defined in the USER_ROLES setting (optional)

MANAGER_ROLES = (
    'staff_manager', 'business_manager'
)

Subroles can have sub-subroles and so on. But be careful not to repeat the names!

Decorator

The role_required decorator provides similar behavior to Django's login_required and permission_required decorators. If the user accessing the view does not have the required roles, they will be redirected to the login page.

from userroles.decorators import role_required

@role_required('manager', 'moderator')
def view(request):
    ...

or

from userroles.decorators import role_required
from userroles import roles

@role_required(roles.manager, roles.moderator)
def view(request):
    ...

If user has a subrole of the required role, it passes de user test as well!

Utils

subrole_of

from userroles import roles

roles.staff_manager.subrole_of( 'manager' ) == True
roles.staff_manager.subrole_of( roles.manager ) == True

roles.staff_manager.subrole_of( 'moderator' ) == False
roles.staff_manager.subrole_of( roles.moderator ) == False

has_subrole

from userroles import roles

roles.manager.has_subrole( 'staff_manager' ) == True
roles.manager.has_subrole( roles.staff_manager ) == True

roles.moderator.has_subrole( 'staff_manager' ) == False
roles.moderator.has_subrole( roles.staff_manager ) == False

Get (sub)role

from userroles import roles

roles.manager
roles.get('manager')

Set (sub)role

from userroles.models import set_user_role

set_user_role(self.user, 'manager')

or

from userroles.models import set_user_role
from userroles import roles

set_user_role(self.user, roles.manager)

Check (sub)role

from userroles import roles

user.role == roles.manager
user.role in (roles.manager, roles.moderator)
user.role.is_moderator
user.role.is_staff_manager