Pre-release

This release is a pre-release and may not be stable for production use.

https://github.com/django-guardian/django-guardian/workflows/Tests/badge.svg?branch=devel https://img.shields.io/pypi/v/django-guardian.svg https://img.shields.io/pypi/pyversions/django-guardian.svg

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.8+

  • A supported version of Django (currently 3.2+)

GitHub Actions run tests against Django versions 3.2, 4.1, 4.2, 5.0 and main.

Installation

To install django-guardian simply run:

pip install django-guardian

Configuration

We need to hook django-guardian into our project.

  1. Put guardian into your INSTALLED_APPS at settings module:

INSTALLED_APPS = (
 ...
 'guardian',
)

  1. Add extra authorization backend to your settings.py:

AUTHENTICATION_BACKENDS = (
    'django.contrib.auth.backends.ModelBackend', # default
    'guardian.backends.ObjectPermissionBackend',
)

  1. 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)

Project links

Data verified by PyPI on Jan 24, 2025
Data provided by the project maintainers, verified at the time the release was uploaded to PyPI.

Key dates

PyPI data
Data sourced directly from PyPI's database.
  • Released:
Newer release available (3.4.1)

4 maintainers

PyPI data
Data sourced directly from PyPI's database.
Avatar for adobrawy from gravatar.com adobrawy Avatar for LukaszBalcerzak from gravatar.com LukaszBalcerzak Avatar for penguin_brian from gravatar.com penguin_brian
+1 more Avatar for thclark from gravatar.com thclark

Credits

Author: Lukasz Balcerzak

GitHub Statistics

Data verified by PyPI on Jan 24, 2025
The GitHub source repository was provided by the project maintainers and verified by PyPI at the time of upload. Stars, forks, and open issues/PRs are derived from that repository and have not been independently verified.

License

BSD License (BSD)

Requires

Python >=3.8

Classifiers

Report project as malware

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.0rc1.tar.gz (159.9 kB view details)

Uploaded Source

Built Distribution

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

django_guardian-3.0.0rc1-py3-none-any.whl (106.9 kB view details)

Uploaded Python 3

File details

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

File metadata

  • Download URL: django_guardian-3.0.0rc1.tar.gz
  • Upload date:
  • Size: 159.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.0rc1.tar.gz
Algorithm Hash digest
SHA256 82c6b00b6731c6fa521a6cbf6c77ab1d6ab22e55eeb9f5e6ee415e78112f321d
MD5 425c0c23944c0ac631ff5fe2564e15af
BLAKE2b-256 4afd8ae8267ac7f91d479347af4eea0768b31c4b68a7c177c16e67cfaf79d247

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_guardian-3.0.0rc1.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.

File details

Details for the file django_guardian-3.0.0rc1-py3-none-any.whl.

File metadata

File hashes

Hashes for django_guardian-3.0.0rc1-py3-none-any.whl
Algorithm Hash digest
SHA256 fbe0f4a08bf005687bf61d327a293a22214c64852e5949c48eb45cce0cd6f162
MD5 d4d76e52e664b871daf446a50b15b86b
BLAKE2b-256 8c140668e471a901f99d4f2e746919678bcb8b9c4582c1fc6cf16b30483d1df4

See more details on using hashes here.

Provenance

The following attestation bundles were made for django_guardian-3.0.0rc1-py3-none-any.whl:

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.

Release history Release notifications | RSS feed

3.4.1

2 files

3.4.0

2 files

3.3.4

2 files

3.3.3

2 files

3.3.2

2 files

3.3.1

2 files

3.3.0

2 files

3.2.0

2 files

3.1.3

2 files

3.1.2

2 files

3.1.1

2 files

3.1.0

2 files

3.0.7

2 files

3.0.6

2 files

3.0.5

2 files

3.0.4

2 files

3.0.3

2 files

3.0.2

2 files

3.0.0

2 files

This release
Pre-release

3.0.0rc1 This release

2 files

2.4.0

2 files

2.3.0

2 files

2.2.0

2 files

2.1.0

2 files

2.0.0

2 files

1.5.1

2 files

1.5.0

2 files

1.4.9

2 files

1.4.8

2 files

1.4.6

2 files

1.4.5

1 file

1.4.4

1 file

1.4.3

1 file

1.4.2

1 file

1.4.1

1 file

1.4.0

1 file

1.3.2

1 file

1.3.1

1 file

1.3

1 file

1.2.5

1 file

1.2.4

1 file

1.2.3

1 file

1.2.2

1 file

1.2.1

1 file

1.2.0

1 file

1.1.1

1 file

1.1.0

1 file

Pre-release

1.1.0.beta

1 file

1.0.4

1 file

1.0.3

1 file

1.0.2

1 file

1.0.1

1 file

1.0.0

1 file

Pre-release

1.0.0.beta2

1 file

Pre-release

1.0.0.beta1

1 file

Pre-release

1.0.0.alpha2

1 file

Pre-release

1.0.0.alpha1

1 file

0.2.3

1 file

0.2.2

1 file

0.2.1

1 file

0.2.0

1 file

0.1.1

1 file

0.1.0

1 file

Anthropic, PBC Visionary sponsor Bloomberg Visionary sponsor Hudson River Trading Visionary sponsor Meta Visionary sponsor NVIDIA Visionary sponsor Microsoft Sustainability sponsor Depot Continuous Integration AWS Cloud computing and Security Sponsor Datadog Monitoring Fastly CDN Google Download Analytics Sentry Error logging StatusPage Status page