Implementation of per object permissions for Django.
Project description
django-guardian is an implementation of per object permissions [1] on top of Django’s authorization backend
Documentation
Online documentation is available at https://django-guardian.readthedocs.io/.
Requirements
Python 3.5+
A supported version of Django (currently 2.1+)
Travis CI tests on Django version 2.1, 2.2, and master.
Installation
To install django-guardian simply run:
pip install django-guardian
Configuration
We need to hook django-guardian into our project.
Put guardian into your INSTALLED_APPS at settings module:
INSTALLED_APPS = (
...
'guardian',
)Add extra authorization backend to your settings.py:
AUTHENTICATION_BACKENDS = (
'django.contrib.auth.backends.ModelBackend', # default
'guardian.backends.ObjectPermissionBackend',
)Create guardian database tables by running:
python manage.py migrate
Usage
After installation and project hooks we can finally use object permissions with Django.
Lets start really quickly:
>>> from django.contrib.auth.models import User, Group
>>> jack = User.objects.create_user('jack', 'jack@example.com', 'topsecretagentjack')
>>> admins = Group.objects.create(name='admins')
>>> jack.has_perm('change_group', admins)
False
>>> from guardian.models import UserObjectPermission
>>> UserObjectPermission.objects.assign_perm('change_group', jack, obj=admins)
<UserObjectPermission: admins | jack | change_group>
>>> jack.has_perm('change_group', admins)
TrueOf course our agent jack here would not be able to change_group globally:
>>> jack.has_perm('change_group')
FalseAdmin integration
Replace admin.ModelAdmin with GuardedModelAdmin for those models which should have object permissions support within admin panel.
For example:
from django.contrib import admin
from myapp.models import Author
from guardian.admin import GuardedModelAdmin
# Old way:
#class AuthorAdmin(admin.ModelAdmin):
# pass
# With object permissions support
class AuthorAdmin(GuardedModelAdmin):
pass
admin.site.register(Author, AuthorAdmin)Release history Release notifications | RSS feed
Download files
Download the file for your platform. If you're not sure which to choose, learn more about installing packages.
Source Distribution
Built Distribution
Hashes for django_guardian-2.1.0-py3-none-any.whl
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | e638c9a23eeac534bb68b133975539ed8782f733ab6f35c0b23b4c39cd06b1bb |
|
| MD5 | 01545ac984dca930c2138f0a08f73bde |
|
| BLAKE2b-256 | bc93758e42add82fe62a6b217777f028ad692471d2cad6bf59ea2736f82be3e8 |
