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.2+)
GitHub Actions run tests against Django versions 2.2, 3.0, 3.1, 3.2, and main.
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
File details
Details for the file django-guardian-2.4.0.tar.gz.
File metadata
- Download URL: django-guardian-2.4.0.tar.gz
- Upload date:
- Size: 159.0 kB
- Tags: Source
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | c58a68ae76922d33e6bdc0e69af1892097838de56e93e78a8361090bcd9f89a0 |
|
| MD5 | 6e961a95b2fe10c0f795b3f3d313b20c |
|
| BLAKE2b-256 | 6f4cd1f6923a0ad7f16c403a54c09e94acb76ac6c3765e02523fb09b2b03e1a8 |
File details
Details for the file django_guardian-2.4.0-py3-none-any.whl.
File metadata
- Download URL: django_guardian-2.4.0-py3-none-any.whl
- Upload date:
- Size: 106.1 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? No
- Uploaded via: twine/3.4.1 importlib_metadata/4.0.1 pkginfo/1.7.0 requests/2.25.1 requests-toolbelt/0.9.1 tqdm/4.60.0 CPython/3.7.10
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 | 440ca61358427e575323648b25f8384739e54c38b3d655c81d75e0cd0d61b697 |
|
| MD5 | dfe84f444671fd8769099fb6e7746a6a |
|
| BLAKE2b-256 | a225869df12e544b51f583254aadbba6c1a95e11d2d08edeb9e58dd715112db5 |
