django-guardian
django-guardian is an implementation of per-object permissions on top
of Django’s authorization backend. Read an introduction to per-object permissions on djangoadvent articles.
Documentation
Online documentation is available at https://django-guardian.readthedocs.io/.
Installation
To install django-guardian into your project run:
uv add django-guardian
TIP: Not using a package manager like
uvorpoetryfor your django project? You probably should try them :). In the meantime,pip install django-guardianworks just fine too.
Configuration
We need to hook django-guardian into our project.
- Put
guardianinto yourINSTALLED_APPSat settings module:
INSTALLED_APPS = (
...
'guardian',
)
- Add extra authorization backend to your
settings.py:
AUTHENTICATION_BACKENDS = (
'django.contrib.auth.backends.ModelBackend',
'guardian.backends.ObjectPermissionBackend',
)
- Create
guardiandatabase 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.shortcuts import assign_perm
>>> 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)
Django Unfold integration
Users of django-unfold will find that guardian is supported out of the box via a contrib module.
4 maintainers
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
Filter files by name, interpreter, ABI, and platform.
If you're not sure about the file name format, learn more about wheel file names.
Copy a direct link to the current filters
File details
Details for the file django_guardian-3.0.4.tar.gz.
File metadata
- Download URL: django_guardian-3.0.4.tar.gz
- Upload date:
- Size: 85.1 kB
- Tags: Source
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
1462739aa57ea15435bbc1f722ad37a1b4aec80964a6eadd2ac5b3492e57d343
|
|
| MD5 |
caae36c5ff18c762d723eed58516e078
|
|
| BLAKE2b-256 |
000a28ad4968f012d31d4d34bcae2170ceec3e13fa88e3e65d52894956dbcd94
|
Provenance
The following attestation bundles were made for django_guardian-3.0.4.tar.gz:
Publisher:
release-publish.yml on django-guardian/django-guardian
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
django_guardian-3.0.4.tar.gz -
Subject digest:
1462739aa57ea15435bbc1f722ad37a1b4aec80964a6eadd2ac5b3492e57d343 - Sigstore transparency entry: 438367409
- Sigstore integration time:
-
Permalink:
django-guardian/django-guardian@a516020393f76a057481f187f271d457584b5637 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/django-guardian
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release-publish.yml@a516020393f76a057481f187f271d457584b5637 -
Trigger Event:
workflow_dispatch
-
Statement type:
File details
Details for the file django_guardian-3.0.4-py3-none-any.whl.
File metadata
- Download URL: django_guardian-3.0.4-py3-none-any.whl
- Upload date:
- Size: 117.6 kB
- Tags: Python 3
- Uploaded using Trusted Publishing? Yes
- Uploaded via:
twine/6.1.0 CPython/3.12.8
File hashes
| Algorithm | Hash digest | |
|---|---|---|
| SHA256 |
c6e07165f5e7174d004f7814cca76f66af1986147c4420bc656469629e29dec5
|
|
| MD5 |
33ee88e6ceb3c6b73e6a37562c770dc0
|
|
| BLAKE2b-256 |
8cd3eec11b28c4682aa638f80e385e42cb776b829abd369db533e80ee8d4d730
|
Provenance
The following attestation bundles were made for django_guardian-3.0.4-py3-none-any.whl:
Publisher:
release-publish.yml on django-guardian/django-guardian
-
Statement:
-
Statement type:
https://in-toto.io/Statement/v1 -
Predicate type:
https://docs.pypi.org/attestations/publish/v1 -
Subject name:
django_guardian-3.0.4-py3-none-any.whl -
Subject digest:
c6e07165f5e7174d004f7814cca76f66af1986147c4420bc656469629e29dec5 - Sigstore transparency entry: 438367429
- Sigstore integration time:
-
Permalink:
django-guardian/django-guardian@a516020393f76a057481f187f271d457584b5637 -
Branch / Tag:
refs/heads/main - Owner: https://github.com/django-guardian
-
Access:
public
-
Token Issuer:
https://token.actions.githubusercontent.com -
Runner Environment:
github-hosted -
Publication workflow:
release-publish.yml@a516020393f76a057481f187f271d457584b5637 -
Trigger Event:
workflow_dispatch
-
Statement type:
