Registry / web-framework / drf-excel

drf-excel

JSON →
library2.5.3pypypiunverified

Django REST Framework renderer for generating Excel spreadsheet (.xlsx) files from DRF responses using OpenPyXL. Current version 2.5.3, requires Python >=3.9, DRF >=3.14. Release cadence: irregular, with maintenance updates and occasional bug fixes.

pip install drf-excel
INSTALL
IMPORT
SIG · DRF-EXCEL
D
drf-excel
web-frameworkpythonv2.5.3
Install
3.9s avg
Import
—
Disk
73MB
Pass rate
10/ 10
Env Coverage10 / 10
glibc
3.9–3.13
musl
3.9–3.13
Install & Compatibility
Where this runs
tested against v2.5.3 · pip install
no network on importno background threads
Install × environment matrix
Each cell = how many times install + import succeeded across repeated harness runs. Partial = flaky.
glibc = Debian/Ubuntu slim · musl = Alpine Linux
musl
py 3.10–3.95 runs
installs and imports cleanly · install 0.0s · import 0.000s · 73.4MB
glibc
py 3.10–3.95 runs
installs and imports cleanly · install 3.9s · import 0.000s · 74MB
73MB installed
● package 73MB
Code
Verified usage

Verified import paths — ran on the pinned version, not inferred.

XLSXFileRenderer
✓ from drf_excel.renderers import XLSXFileRenderer
✗ from drf_excel.renderers import XLSXFileRenderer

Basic usage: mixin + renderer, minimal setup.

from rest_framework import viewsets from drf_excel.renderers import XLSXFileRenderer from drf_excel.mixins import XLSXMixin from myapp.models import MyModel from myapp.serializers import MySerializer class MyViewSet(XLSXMixin, viewsets.ModelViewSet): queryset = MyModel.objects.all() serializer_class = MySerializer renderer_classes = [XLSXFileRenderer] filename = 'my_export.xlsx' def get_queryset(self): # Add filtering if needed return super().get_queryset().filter(is_active=True)
Debug
Known issues
breakingVersion 2.2.0 removed NullBooleanField and requires DRF >=3.14. Upgrade from older versions may break if using NullBooleanField or older DRF.
fix
Upgrade to DRF >=3.14 and replace NullBooleanField with BooleanField(null=True).
affects: <2.2.0
gotchaPagination can break the renderer if your view uses pagination. The renderer expects the full list, not a paginated response.
fix
Disable pagination for the export endpoint, or override list() to return the entire queryset.
affects: all
gotchaIf you use `_lazy` translations in serializer fields, they may not be rendered correctly in Excel without special handling.
fix
Upgrade to drf-excel >=2.4.0 for lazy translation support.
affects: <2.4.0
Upgrade
Version history
2.5.3latest on PyPI · released Mar 7, 2025
Audit
Dependencies
djangorestframeworkrequiredRequired, version >=3.14
openpyxlrequiredRequired for Excel generation
Agent activity
8 hits · last 30 days
node
8
Resources
drf-excel — pip install drf-excel · libregistry