{"id":17125920,"url":"https://github.com/manfred-kaiser/restframework-serializer-permissions","last_synced_at":"2025-04-13T06:26:16.165Z","repository":{"id":53107094,"uuid":"353629659","full_name":"manfred-kaiser/restframework-serializer-permissions","owner":"manfred-kaiser","description":"Drop in replacement for Django Restframework Serializers to add permission based field serialization.","archived":false,"fork":false,"pushed_at":"2021-04-06T13:24:00.000Z","size":29,"stargazers_count":12,"open_issues_count":2,"forks_count":1,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-10T16:53:51.180Z","etag":null,"topics":["django","django-rest-framework","permissions","serialization"],"latest_commit_sha":null,"homepage":"","language":"Python","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/manfred-kaiser.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2021-04-01T08:30:14.000Z","updated_at":"2024-04-23T17:42:10.000Z","dependencies_parsed_at":"2022-09-17T08:00:26.207Z","dependency_job_id":null,"html_url":"https://github.com/manfred-kaiser/restframework-serializer-permissions","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manfred-kaiser%2Frestframework-serializer-permissions","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manfred-kaiser%2Frestframework-serializer-permissions/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manfred-kaiser%2Frestframework-serializer-permissions/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/manfred-kaiser%2Frestframework-serializer-permissions/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/manfred-kaiser","download_url":"https://codeload.github.com/manfred-kaiser/restframework-serializer-permissions/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248672239,"owners_count":21143245,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["django","django-rest-framework","permissions","serialization"],"created_at":"2024-10-14T18:46:11.610Z","updated_at":"2025-04-13T06:26:16.138Z","avatar_url":"https://github.com/manfred-kaiser.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"restframework-serializer-permissions\n====================================\n\nDrop in replacement for [Django Restframework Serializers](https://www.django-rest-framework.org/api-guide/serializers/) to add permission based field serialization.\n\nInstallation\n------------\n\nInstall this module into your environment:\n\n    $ pip install restframework-serializer-permissions\n\n\nExample\n-------\n\nThis example uses a ModelSerializer as described in [DRF Docs](https://www.django-rest-framework.org/api-guide/serializers/#modelserializer)\n\n```python\n# import permissions from rest_framework\nfrom rest_framework.permissions import AllowAny, IsAuthenticated\n\n# import serializers from serializer_permissions instead of rest_framework\nfrom serializer_permissions  import serializers\n\n# import you models\nfrom myproject.models import ShoppingItem, ShoppingList\n\n\nclass ShoppingItemSerializer(serializers.ModelSerializer):\n\n    item_name = serializers.CharField()\n\n    class Meta:\n        # metaclass as described in drf docs\n        model = ShoppingItem\n        fields = ('item_name', )\n\n\nclass ShoppingListSerializer(serializers.ModelSerializer):\n\n    # Allow all users to list name\n    list_name = serializers.CharField(permission_classes=(AllowAny, ))\n\n    # Only allow authenticated users to retrieve the comment\n    list_comment = serializers.CharField(permissions=(IsAuthenticated, ))\n\n    # show owner only, when the current user has 'auth.view_user' permission\n    owner = serializers.CharField(permissions=('auth.view_user', ), hide=True)\n\n    # serializer which is only available, when the user is authenticated\n    items = ShoppingItemSerializer(many=True, permissions=(IsAuthenticated, ), hide=True)\n\n    class Meta:\n        # metaclass as described in drf docs\n        model = ShoppingItem\n        fields = ('list_name', 'list_comment', 'owner', 'items', )\n```\n\nYou can also define your own permissions classes as described in the  [DRF documentation](https://www.django-rest-framework.org/api-guide/permissions/#custom-permissions) and specify multiple r`permission_classes` and r`permissions` on a field or serializer: all provided permissions must be satisfied for the visitor to retrieve the given field.\n\n\nCompatibility\n-------------\n\nThis package should be compatible with:\n\n* Django Rest Framework 3\n* Django 2.x, 3.x\n* Python 3.6, 3.7, 3.8\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanfred-kaiser%2Frestframework-serializer-permissions","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmanfred-kaiser%2Frestframework-serializer-permissions","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmanfred-kaiser%2Frestframework-serializer-permissions/lists"}