Flexible action level permissions for Django REST framework
Project description
drf-action-permissions
Release | CI | Coverage |
---|---|---|
Flexible ability to add action permissions on view level for Django REST framework. Permissions can be as complex or simple as you want. It can be a plain string or a function.
Requirements
- Python (3.6+)
- Django (1.11.x, 2.0+)
- Django REST Framework (3.7+)
Installation
$ pip install drf-common-exceptions
You cound define common permissions class for whole project:
REST_FRAMEWORK = {
...
"DEFAULT_PERMISSION_CLASSES": (
"drf_action_permissions.DjangoActionPermissions",
)
...
}
Or use it just for particular viewset in combination with others:
from rest_framework.permissions import IsAuthenticated
from rest_framework.viewsets import ModelViewSet
from drf_action_permissions import DjangoActionPermissions
class MyView(viewsets.ModelViewSet):
permission_classes = (IsAuthenticated, DjangoActionPermissions)
perms_map_action = {
'retrieve': ['users.view_user'],
}
Usage examples
Permission as string template or plain string:
class PostViewSet(ModelViewSet):
permission_classes = (IsAuthenticated, DjangoActionPermissions)
perms_map_action = {
'likes': ['%(app_label)s.view_%(model_name)s_list',
'%(app_label)s.view_like_list'],
}
Permission as function with current object access:
def can_view_application(user, _view, obj):
"""Can view only archived applications."""
if obj.is_archived:
return user.has_perm('applications.view_archived_application')
return user.has_perm('applications.view_application')
class ApplicationView(ModelViewSet):
permission_classes = (IsAuthenticated, DjangoActionPermissions)
perms_map_action_obj = {
'retrieve': [can_view_application],
}
Development
Install poetry and requirements:
$ curl -sSL https://raw.githubusercontent.com/sdispater/poetry/master/get-poetry.py | python
$ python3 -m venv path/to/venv
$ source path/to/venv/bin/activate
$ poetry install
Run main commands:
$ make test
$ make watch
$ make clean
$ make lint
Publish to pypi by default patch version:
$ make publish
or any level you want:
$ make publish minor
Project details
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
Close
Hashes for drf-action-permissions-0.1.1.tar.gz
Algorithm | Hash digest | |
---|---|---|
SHA256 | 0d5cc71c71200255e0cf5d340d2476c1b5b0886047af443614c953c8cde04643 |
|
MD5 | d9c8af994c7b139d29a77d11e9e0ef77 |
|
BLAKE2b-256 | 00aa7551f506a0cb1716cb8100e45ed65cf3e153f738879992164680009f7e1b |
Close
Hashes for drf_action_permissions-0.1.1-py3-none-any.whl
Algorithm | Hash digest | |
---|---|---|
SHA256 | 386e6dca7ac914844deb781022b5c7b59a16d09cde78cfefee92c1ec55eb31b5 |
|
MD5 | 4f67e628003b3b316b33472f156882ea |
|
BLAKE2b-256 | 29b1d0ee7af178b7bcf00146bd5082ac976abf9a7a288030207819bcb5ad1828 |