# django-rest-framework-guardian
[](https://circleci.com/gh/rpkilby/django-rest-framework-guardian)
[](https://codecov.io/gh/rpkilby/django-rest-framework-guardian)
[](https://pypi.org/project/djangorestframework-guardian)
[](https://pypi.org/project/djangorestframework-guardian)
[](https://pypi.org/project/djangorestframework-guardian/)
django-rest-framework-guardian provides django-guardian integrations for Django REST Framework.
Currently, this only includes the `ObjectPermissionsFilter`.
## Installation & Setup
To use django-rest-framework-guardian, install it into your environment.
```sh
$ pip install djangorestframework-guardian
```
Ensure both Django REST Framework and django-guardian are configured and added to your `INSTALLED_APPS` setting.
```python
INSTALLED_APPS = [
'rest_framework',
'guardian',
]
AUTHENTICATION_BACKENDS = [
'django.contrib.auth.backends.ModelBackend',
'guardian.backends.ObjectPermissionBackend',
]
```
## ObjectPermissionsFilter
The filter will ensure that querysets only returns objects for which the user has the appropriate view permission.
If you're using `ObjectPermissionsFilter`, you'll probably also want to add an appropriate object permissions
class, to ensure that users can only operate on instances if they have the appropriate object permissions. The easiest
way to do this is to subclass `DjangoObjectPermissions` and add `'view'` permissions to the `perms_map` attribute.
An example using both `ObjectPermissionsFilter` and `DjangoObjectPermissions` might look like the following:
**permissions.py**:
```python
from rest_framework import permissions
class CustomObjectPermissions(permissions.DjangoObjectPermissions):
"""
Similar to `DjangoObjectPermissions`, but adding 'view' permissions.
"""
perms_map = {
'GET': ['%(app_label)s.view_%(model_name)s'],
'OPTIONS': ['%(app_label)s.view_%(model_name)s'],
'HEAD': ['%(app_label)s.view_%(model_name)s'],
'POST': ['%(app_label)s.add_%(model_name)s'],
'PUT': ['%(app_label)s.change_%(model_name)s'],
'PATCH': ['%(app_label)s.change_%(model_name)s'],
'DELETE': ['%(app_label)s.delete_%(model_name)s'],
}
```
**views.py**:
```python
from rest_framework import viewsets
from rest_framework_guardian import filters
from myapp.models import Event
from myapp.permissions import CustomObjectPermissions
from myapp.serializers import EventSerializer
class EventViewSet(viewsets.ModelViewSet):
"""
Viewset that only lists events if user has 'view' permissions, and only
allows operations on individual events if user has appropriate 'view', 'add',
'change' or 'delete' permissions.
"""
queryset = Event.objects.all()
serializer_class = EventSerializer
permission_classes = [CustomObjectPermissions]
filter_backends = [filters.ObjectPermissionsFilter]
```
## ObjectPermissionsAssignmentMixin
A serializer mixin that allows permissions to be easily assigned to users and/or groups.
So each time an object is created or updated, the `permissions_map` returned by `Serializer.get_permissions_map` will be used to assign permission(s) to that object.
Please note that the existing permissions will remain intact.
A usage example might look like the following:
```python
from rest_framework_guardian.serializers import ObjectPermissionsAssignmentMixin
from blog.models import Post
class PostSerializer(ObjectPermissionsAssignmentMixin, serializers.ModelSerializer):
class Meta:
model = Post
fields = '__all__'
def get_permissions_map(self, created):
current_user = self.context['request'].user
readers = Group.objects.get(name='readers')
supervisors = Group.objects.get(name='supervisors')
return {
'view_post': [current_user, readers],
'change_post': [current_user],
'delete_post': [current_user, supervisors]
}
```
## Release Process
- Update changelog
- Update package version in setup.py
- Create git tag for version
- Build & upload release to PyPI
```bash
$ pip install -U pip setuptools wheel twine
$ rm -rf dist/ build/
$ python setup.py bdist_wheel
$ twine upload dist/*
```
## License
See: [LICENSE](https://github.com/rpkilby/django-rest-framework-guardian/blob/master/LICENSE)
BSD 3-Clause License
Copyright (c) 2018, Ryan P Kilby
All rights reserved.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions are met:
* Redistributions of source code must retain the above copyright notice, this
list of conditions and the following disclaimer.
* Redistributions in binary form must reproduce the above copyright notice,
this list of conditions and the following disclaimer in the documentation
and/or other materials provided with the distribution.
* Neither the name of the copyright holder nor the names of its
contributors may be used to endorse or promote products derived from
this software without specific prior written permission.
THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS "AS IS"
AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE
DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR
SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER
CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,
OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE
OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.
Raw data
{
"_id": null,
"home_page": "https://github.com/rpkilby/django-rest-framework-guardian",
"name": "djangorestframework-guardian",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "Ryan P Kilby",
"author_email": "kilbyr@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/e5/80/0f2190bacfe7c7b2e22d0e1e695882ec3123f9e58817c8392a258cd46442/djangorestframework-guardian-0.3.0.tar.gz",
"platform": "",
"description": "# django-rest-framework-guardian\n\n[](https://circleci.com/gh/rpkilby/django-rest-framework-guardian)\n[](https://codecov.io/gh/rpkilby/django-rest-framework-guardian)\n[](https://pypi.org/project/djangorestframework-guardian)\n[](https://pypi.org/project/djangorestframework-guardian)\n[](https://pypi.org/project/djangorestframework-guardian/)\n\ndjango-rest-framework-guardian provides django-guardian integrations for Django REST Framework.\nCurrently, this only includes the `ObjectPermissionsFilter`.\n\n\n## Installation & Setup\n\nTo use django-rest-framework-guardian, install it into your environment.\n\n```sh\n$ pip install djangorestframework-guardian\n```\n\nEnsure both Django REST Framework and django-guardian are configured and added to your `INSTALLED_APPS` setting.\n\n```python\nINSTALLED_APPS = [\n 'rest_framework',\n 'guardian',\n]\n\nAUTHENTICATION_BACKENDS = [\n 'django.contrib.auth.backends.ModelBackend',\n 'guardian.backends.ObjectPermissionBackend',\n]\n```\n\n\n## ObjectPermissionsFilter\n\nThe filter will ensure that querysets only returns objects for which the user has the appropriate view permission.\n\nIf you're using `ObjectPermissionsFilter`, you'll probably also want to add an appropriate object permissions\nclass, to ensure that users can only operate on instances if they have the appropriate object permissions. The easiest\nway to do this is to subclass `DjangoObjectPermissions` and add `'view'` permissions to the `perms_map` attribute.\n\nAn example using both `ObjectPermissionsFilter` and `DjangoObjectPermissions` might look like the following:\n\n**permissions.py**:\n\n```python\nfrom rest_framework import permissions\n\n\nclass CustomObjectPermissions(permissions.DjangoObjectPermissions):\n \"\"\"\n Similar to `DjangoObjectPermissions`, but adding 'view' permissions.\n \"\"\"\n perms_map = {\n 'GET': ['%(app_label)s.view_%(model_name)s'],\n 'OPTIONS': ['%(app_label)s.view_%(model_name)s'],\n 'HEAD': ['%(app_label)s.view_%(model_name)s'],\n 'POST': ['%(app_label)s.add_%(model_name)s'],\n 'PUT': ['%(app_label)s.change_%(model_name)s'],\n 'PATCH': ['%(app_label)s.change_%(model_name)s'],\n 'DELETE': ['%(app_label)s.delete_%(model_name)s'],\n }\n```\n\n**views.py**:\n\n```python\nfrom rest_framework import viewsets\nfrom rest_framework_guardian import filters\n\nfrom myapp.models import Event\nfrom myapp.permissions import CustomObjectPermissions\nfrom myapp.serializers import EventSerializer\n\n\nclass EventViewSet(viewsets.ModelViewSet):\n \"\"\"\n Viewset that only lists events if user has 'view' permissions, and only\n allows operations on individual events if user has appropriate 'view', 'add',\n 'change' or 'delete' permissions.\n \"\"\"\n queryset = Event.objects.all()\n serializer_class = EventSerializer\n permission_classes = [CustomObjectPermissions]\n filter_backends = [filters.ObjectPermissionsFilter]\n```\n\n\n## ObjectPermissionsAssignmentMixin\n\nA serializer mixin that allows permissions to be easily assigned to users and/or groups.\nSo each time an object is created or updated, the `permissions_map` returned by `Serializer.get_permissions_map` will be used to assign permission(s) to that object.\n\nPlease note that the existing permissions will remain intact.\n\nA usage example might look like the following:\n\n```python\nfrom rest_framework_guardian.serializers import ObjectPermissionsAssignmentMixin\n\nfrom blog.models import Post\n\n\nclass PostSerializer(ObjectPermissionsAssignmentMixin, serializers.ModelSerializer):\n class Meta:\n model = Post\n fields = '__all__'\n\n def get_permissions_map(self, created):\n current_user = self.context['request'].user\n readers = Group.objects.get(name='readers')\n supervisors = Group.objects.get(name='supervisors')\n\n return {\n 'view_post': [current_user, readers],\n 'change_post': [current_user],\n 'delete_post': [current_user, supervisors]\n }\n\n```\n\n\n## Release Process\n\n- Update changelog\n- Update package version in setup.py\n- Create git tag for version\n- Build & upload release to PyPI\n ```bash\n $ pip install -U pip setuptools wheel twine\n $ rm -rf dist/ build/\n $ python setup.py bdist_wheel\n $ twine upload dist/*\n ```\n\n## License\n\nSee: [LICENSE](https://github.com/rpkilby/django-rest-framework-guardian/blob/master/LICENSE)\n\nBSD 3-Clause License\n\nCopyright (c) 2018, Ryan P Kilby\nAll rights reserved.\n\nRedistribution and use in source and binary forms, with or without\nmodification, are permitted provided that the following conditions are met:\n\n* Redistributions of source code must retain the above copyright notice, this\n list of conditions and the following disclaimer.\n\n* Redistributions in binary form must reproduce the above copyright notice,\n this list of conditions and the following disclaimer in the documentation\n and/or other materials provided with the distribution.\n\n* Neither the name of the copyright holder nor the names of its\n contributors may be used to endorse or promote products derived from\n this software without specific prior written permission.\n\nTHIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS \"AS IS\"\nAND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE\nIMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE ARE\nDISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT HOLDER OR CONTRIBUTORS BE LIABLE\nFOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL\nDAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR\nSERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER\nCAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY,\nOR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE\nOF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE.\n\n\n",
"bugtrack_url": null,
"license": "BSD",
"summary": "django-guardian support for Django REST Framework",
"version": "0.3.0",
"project_urls": {
"Homepage": "https://github.com/rpkilby/django-rest-framework-guardian",
"Source": "https://github.com/rpkilby/django-rest-framework-guardian",
"Tracker": "https://github.com/rpkilby/django-rest-framework-guardian/issues"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "9bcc35c1d8fb99172b2646f29e270e9ec443ffe09e0b63e61cd528d4fb4b8b07",
"md5": "e6c1c3eee9218838aa754b22527e2d65",
"sha256": "3bd3dd6ea58e1bceca5048faf6f8b1a93bb5dcff30ba5eb91b9a0e190a48a0c7"
},
"downloads": -1,
"filename": "djangorestframework_guardian-0.3.0-py2.py3-none-any.whl",
"has_sig": false,
"md5_digest": "e6c1c3eee9218838aa754b22527e2d65",
"packagetype": "bdist_wheel",
"python_version": "py2.py3",
"requires_python": null,
"size": 6931,
"upload_time": "2019-08-02T01:00:39",
"upload_time_iso_8601": "2019-08-02T01:00:39.543144Z",
"url": "https://files.pythonhosted.org/packages/9b/cc/35c1d8fb99172b2646f29e270e9ec443ffe09e0b63e61cd528d4fb4b8b07/djangorestframework_guardian-0.3.0-py2.py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "e5800f2190bacfe7c7b2e22d0e1e695882ec3123f9e58817c8392a258cd46442",
"md5": "094e87bbeb9c28878636f5452980fd1e",
"sha256": "1883756452d9bfcc2a51fb4e039a6837a8f6697c756447aa83af085749b59330"
},
"downloads": -1,
"filename": "djangorestframework-guardian-0.3.0.tar.gz",
"has_sig": false,
"md5_digest": "094e87bbeb9c28878636f5452980fd1e",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 8647,
"upload_time": "2019-10-14T04:24:25",
"upload_time_iso_8601": "2019-10-14T04:24:25.531151Z",
"url": "https://files.pythonhosted.org/packages/e5/80/0f2190bacfe7c7b2e22d0e1e695882ec3123f9e58817c8392a258cd46442/djangorestframework-guardian-0.3.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2019-10-14 04:24:25",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "rpkilby",
"github_project": "django-rest-framework-guardian",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"circle": true,
"tox": true,
"lcname": "djangorestframework-guardian"
}
JSON
