Django REST Envelop

Turn the ViewSet list endpoints to return an object rather than a list directly.

Installation

From PYPi using pip:

pip install django-rest-envelope

In your viewset views, you can use the ListEnvelopeMixin along with another mixin that defines the list() method:

class MyViewSet(ListEnvelopeMixin, ReadOnlyModelViewSet):
    envelope = "my_envelope"

In your ViewSet class that uses the mixin you have to define the envelope attribute.

Additionally, you can overwrite the get_envelope() method to tweak the behaviour of which envelope use in different situations.

By default, django REST ViewSets return a list:

[
  { "id": 1, "foo": "bar" },
  { "id": 2, "foo": "baz" }
]

Once the mixin is applied to that same ViewSet, you get, instead, the following response:

{
  "my_envelope": [
    { "id": 1, "foo": "bar" },
    { "id": 2, "foo": "baz" }
  ]
}

This package is distributed under MIT Licence.

For a detailed explanation of source distributions (sdists) and built distributions (wheels), please see the package formats documentation.

Table of built distributions (wheels) for django-rest-envelope 1.2.0
File	Interpreter	ABI	Platform	Reset
django_rest_envelope-1.2.0-py3-none-any.whl 3.5 kB Oct 13, 2026	Python 3	none	any	Details

Download URL	django_rest_envelope-1.2.0-py3-none-any.whl
Size	3.5 kB
Tags	Python 3
SHA-256 checksum How to use checksums	`6708f9ffbfe6052ee4508c69c5b1d026382e4aad93d107670a3122c6210e8d59`
BLAKE2b-256 checksum How to use checksums	`8b850118cc1ea0bd86a287b40a7e11e224444920877f50dbfa7958f21b786547`
Upload date	Oct 13, 2026
Uploaded using Trusted Publishing? What is trusted publishing?	No
Uploaded via	`twine/7.0.0 CPython/3.11.17`