DRF CRUD Proxy
==============
This package provides extended Django REST Framework generic views and viewsets that provide the possibility to specify
different serializers for reading the incoming request and presenting the response.
This is super handy in situations where you want to, for example, let the user send a ForeignKey attribute,
but present the related object alongside the response instead of only the database ID.
Requirements
------------
- Python 3.6, 3.7, 3.8, 3.9, 3.10 and 3.11
- Django 3.2, 4.0, 4.1 and 4.2 (basically works with older versions as well, but they're EOL)
- Django REST Framework 3.8 or newer (probably works on any 3.x version)
Installation
------------
.. code::
pip install drf-crud-proxy
Usage
-----
Import the generic views and subclass your own views from them. Specify ``request_serializer_class`` and/or
``response_serializer_class`` to the view (both default to DRF's own ``serializer_class`` attribute).
.. code:: python
# api/views.py
from drf_crud_proxy import generics
from app.models import MyModel
from api.serializers import MyModelCreateSerializer, MyModelSerializer
class MyModelListCreateView(generics.ProxiedListCreateAPIView):
queryset = MyModel.objects.all()
request_serializer_class = MyModelCreateSerializer
response_serializer_class = MyModelSerializer
The incoming request is handled with ``MyModelCreateSerializer`` and the response with ``MyModelSerializer``.
If you want to customize the data on either situation, override ``get_request_data`` and/or ``get_response_data``
methods in the view.
The package also supports the so-called ``PUT-as-create`` behavior that was removed from DRF in its 3.0 release. Note that
the user has to have model permissions for the corresponding create behavior (``POST`` request).
**NOTE**: The ``PUT-as-create`` functionality doesn't have tests (yet).
License
-------
MIT
Inspiration
-----------
This functionality in DRF is something I've needed in numerous Django projects, so hopefully this will help someone else
too :)
This package has been built on top of the ideas presented by the great vintasoftware's ``drf-rw-serializers`` (https://github.com/vintasoftware/drf-rw-serializers) package. Thanks!
Raw data
{
"_id": null,
"home_page": "https://github.com/attevaltojarvi/drf-crud-proxy",
"name": "drf-crud-proxy",
"maintainer": null,
"docs_url": null,
"requires_python": null,
"maintainer_email": null,
"keywords": "Django REST Framework, Serializers, REST, API, Django",
"author": "attevaltojarvi",
"author_email": "atte.valtojarvi@gmail.com",
"download_url": "https://files.pythonhosted.org/packages/ed/d2/86b1d881744fa138dd193bfec30df03c8f6ffa85473487573bf2d622f20b/drf_crud_proxy-0.5.0.tar.gz",
"platform": null,
"description": "DRF CRUD Proxy\n==============\n\nThis package provides extended Django REST Framework generic views and viewsets that provide the possibility to specify\ndifferent serializers for reading the incoming request and presenting the response.\n\nThis is super handy in situations where you want to, for example, let the user send a ForeignKey attribute,\nbut present the related object alongside the response instead of only the database ID.\n\nRequirements\n------------\n\n- Python 3.6, 3.7, 3.8, 3.9, 3.10 and 3.11\n- Django 3.2, 4.0, 4.1 and 4.2 (basically works with older versions as well, but they're EOL)\n- Django REST Framework 3.8 or newer (probably works on any 3.x version)\n\nInstallation\n------------\n\n.. code::\n\n pip install drf-crud-proxy\n\nUsage\n-----\n\nImport the generic views and subclass your own views from them. Specify ``request_serializer_class`` and/or\n``response_serializer_class`` to the view (both default to DRF's own ``serializer_class`` attribute).\n\n.. code:: python\n\n # api/views.py\n\n from drf_crud_proxy import generics\n from app.models import MyModel\n from api.serializers import MyModelCreateSerializer, MyModelSerializer\n\n\n class MyModelListCreateView(generics.ProxiedListCreateAPIView):\n queryset = MyModel.objects.all()\n request_serializer_class = MyModelCreateSerializer\n response_serializer_class = MyModelSerializer\n\nThe incoming request is handled with ``MyModelCreateSerializer`` and the response with ``MyModelSerializer``.\n\nIf you want to customize the data on either situation, override ``get_request_data`` and/or ``get_response_data``\nmethods in the view.\n\nThe package also supports the so-called ``PUT-as-create`` behavior that was removed from DRF in its 3.0 release. Note that\nthe user has to have model permissions for the corresponding create behavior (``POST`` request).\n\n**NOTE**: The ``PUT-as-create`` functionality doesn't have tests (yet).\n\nLicense\n-------\n\nMIT\n\nInspiration\n-----------\n\nThis functionality in DRF is something I've needed in numerous Django projects, so hopefully this will help someone else\ntoo :)\n\nThis package has been built on top of the ideas presented by the great vintasoftware's ``drf-rw-serializers`` (https://github.com/vintasoftware/drf-rw-serializers) package. Thanks!\n",
"bugtrack_url": null,
"license": "MIT",
"summary": "Separate serializers for parsing requests and returning responses in DRF",
"version": "0.5.0",
"project_urls": {
"Homepage": "https://github.com/attevaltojarvi/drf-crud-proxy"
},
"split_keywords": [
"django rest framework",
" serializers",
" rest",
" api",
" django"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "94b1d619c4fa51949b27d213244d0848b6153b2b37b250acd2c5980810527e31",
"md5": "0b6c542294f03737f232a532ead2afa3",
"sha256": "e4e1f64dbeffe05bc9573fc856c561dc03298d2990805073b5a34ce1b28e2eca"
},
"downloads": -1,
"filename": "drf_crud_proxy-0.5.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "0b6c542294f03737f232a532ead2afa3",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6752,
"upload_time": "2024-10-02T21:26:51",
"upload_time_iso_8601": "2024-10-02T21:26:51.865856Z",
"url": "https://files.pythonhosted.org/packages/94/b1/d619c4fa51949b27d213244d0848b6153b2b37b250acd2c5980810527e31/drf_crud_proxy-0.5.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "edd286b1d881744fa138dd193bfec30df03c8f6ffa85473487573bf2d622f20b",
"md5": "dc91a50b0ba082402bf55ac003223820",
"sha256": "7317f62998d423fd6d3db6bcc59ce7a0b37b06c1e62efd4a07fa8d0cfaa38bc7"
},
"downloads": -1,
"filename": "drf_crud_proxy-0.5.0.tar.gz",
"has_sig": false,
"md5_digest": "dc91a50b0ba082402bf55ac003223820",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6218,
"upload_time": "2024-10-02T21:26:54",
"upload_time_iso_8601": "2024-10-02T21:26:54.365494Z",
"url": "https://files.pythonhosted.org/packages/ed/d2/86b1d881744fa138dd193bfec30df03c8f6ffa85473487573bf2d622f20b/drf_crud_proxy-0.5.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-02 21:26:54",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "attevaltojarvi",
"github_project": "drf-crud-proxy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"tox": true,
"lcname": "drf-crud-proxy"
}
JSON
