django-guardian

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)
True

Of course our agent jack here would not be able to change_group globally:

>>> jack.has_perm('change_group')
False

Admin 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)

Download files

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

Source Distribution

django-guardian-2.0.0.tar.gz (154.1 kB view details)

Uploaded Jun 11, 2019 Source

Built Distribution

If you're not sure about the file name format, learn more about wheel file names.

The dropdown lists show the available interpreters, ABIs, and platforms. Enable javascript to be able to filter the list of wheel files.

django_guardian-2.0.0-py3-none-any.whl (100.4 kB view details)

Uploaded Jun 11, 2019 Python 3

File details

Details for the file django-guardian-2.0.0.tar.gz.

File metadata

Download URL: django-guardian-2.0.0.tar.gz
Upload date: Jun 11, 2019
Size: 154.1 kB
Tags: Source
Uploaded using Trusted Publishing? No
Uploaded via: Python-urllib/3.5

File hashes

Hashes for django-guardian-2.0.0.tar.gz
Algorithm	Hash digest
SHA256	`965d3a1e20fb3639e0ab16b0e768611f694c02d762916f80d9f3f7520c16aa7b`
MD5	`127058ee38b3926701f8deaeba9584b8`
BLAKE2b-256	`2079111792176451a800eca62666bec579ba84feaceb9852a43abc8b31426ac7`

See more details on using hashes here.

File details

Details for the file django_guardian-2.0.0-py3-none-any.whl.

File metadata

Download URL: django_guardian-2.0.0-py3-none-any.whl
Upload date: Jun 11, 2019
Size: 100.4 kB
Tags: Python 3
Uploaded using Trusted Publishing? No
Uploaded via: Python-urllib/3.5

File hashes

Hashes for django_guardian-2.0.0-py3-none-any.whl
Algorithm	Hash digest
SHA256	`e8c4556c4e145028a5dcfd7b2611d52e1ac104af562017ce17c3f67e47a62693`
MD5	`bef265be0f5163ca15279839b7e94385`
BLAKE2b-256	`d7e9c13dc335ecc6b4a348504b238b5aa9334fcdd3f14c985889fedbd8496d35`