Metadata-Version: 2.1
Name: drf-renderer-xlsx
Version: 0.2.4
Summary: Django REST Framework renderer for spreadsheet (xlsx) files.
Home-page: https://github.com/wharton/drf-renderer-xlsx
Author: Timothy Allen
Author-email: tallen@wharton.upenn.edu
License: UNKNOWN
Description: # Django REST Framework Renderer: XLSX
        
        `drf-renderer-xlsx` provides an XLSX renderer for Django REST Framework. It uses OpenPyXL to create the spreadsheet and returns the data.
        
        # Requirements
        
        It may work with earlier versions, but has been tested with the following:
        
        * Django >= 1.11
        * Django REST Framework >= 3.6
        * OpenPyXL >= 2.4
        
        # Installation
        
            pip install drf-renderer-xlsx
        
        Then add the following to your `REST_FRAMEWORK` settings:
        
            REST_FRAMEWORK = {
                ...
        
                'DEFAULT_RENDERER_CLASSES': (
                    'rest_framework.renderers.JSONRenderer',
                    'rest_framework.renderers.BrowsableAPIRenderer',
                    'drf_renderer_xlsx.renderers.XLSXRenderer',
                ),
            }
        
        To avoid having a file streamed without a filename (which the browser will often default to the filename "download", with no extension), we need to use a mixin to override the Content-Disposition like so:
        
            from rest_framework.viewsets import ReadOnlyModelViewSet
            from drf_renderer_xlsx.mixins import XLSXFileMixin
            from drf_renderer_xlsx.renderers import XLSXRenderer
        
            from .models import MyExampleModel
            from .serializers import MyExampleSerializer
        
            class MyExampleViewSet(XLSXFileMixin, ReadOnlyModelViewSet):
                queryset = MyExampleModel.objects.all()
                serializer_class = MyExampleSerializer
                renderer_classes = (XLSXRenderer,)
        
        
        ## Maintainer
        
        * [Timothy Allen](https://github.com/FlipperPA)
        
        ## Contributors (Thank You!)
        
        * [Pavel Tolstolytko](https://github.com/eshikvtumane)
        
Platform: UNKNOWN
Classifier: Development Status :: 3 - Alpha
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: BSD License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Framework :: Django
Classifier: Topic :: Internet :: WWW/HTTP
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Description-Content-Type: text/markdown
