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 uv or poetry for your django project? You probably should try them :). In the meantime, pip install django-guardian works just fine too.

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',
        '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.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.

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-3.0.0.tar.gz (79.9 kB view details)

Uploaded May 7, 2025 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-3.0.0-py3-none-any.whl (112.7 kB view details)

Uploaded May 7, 2025 Python 3

File details

Details for the file django_guardian-3.0.0.tar.gz.

File metadata

Download URL: django_guardian-3.0.0.tar.gz
Upload date: May 7, 2025
Size: 79.9 kB
Tags: Source
Uploaded using Trusted Publishing? Yes
Uploaded via: twine/6.1.0 CPython/3.12.8

File hashes

Hashes for django_guardian-3.0.0.tar.gz
Algorithm	Hash digest
SHA256	`0c79d55c4af2cfc14fbd19539846a1ebfed2a38198b7697e0f5177b7f654e1cd`
MD5	`218085b14963e54186fe5351f906be6b`
BLAKE2b-256	`30822c76cdf77eae3cb0c3df394686daf8f84bcd604c0da7a26fa19f5fe74ed4`

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_guardian-3.0.0.tar.gz:

Publisher: release-publish.yml on django-guardian/django-guardian

Attestations: Values shown here reflect the state when the release was signed and may no longer be current.

Statement:
- Statement type: https://in-toto.io/Statement/v1
- Predicate type: https://docs.pypi.org/attestations/publish/v1
- Subject name: django_guardian-3.0.0.tar.gz
- Subject digest: 0c79d55c4af2cfc14fbd19539846a1ebfed2a38198b7697e0f5177b7f654e1cd
- Sigstore transparency entry: 208106542
- Sigstore integration time: May 7, 2025
Source repository:
- Permalink: django-guardian/django-guardian@d9587a8a2d3635ceec3b5ce6c4ea4ce1d69a56af
- Branch / Tag: refs/heads/main
- Owner: https://github.com/django-guardian
- Access: public
Publication detail:
- Token Issuer: https://token.actions.githubusercontent.com
- Runner Environment: github-hosted
- Publication workflow: release-publish.yml@d9587a8a2d3635ceec3b5ce6c4ea4ce1d69a56af
- Trigger Event: workflow_dispatch