Metadata-Version: 1.1
Name: django-excel-response
Version: 2.0.0
Summary: Django package to easily render Excel spreadsheets
Home-page: https://github.com/tarkatronic/django-excel-response
Author: Joey Wilhelm
Author-email: tarkatronic@gmail.com
License: Apache
Download-URL: https://github.com/tarkatronic/django-excel-response/archive/master.tar.gz
Description: =====================
        django-excel-response
        =====================
        .. image:: https://img.shields.io/pypi/v/django-excel-response.svg
           :target: https://pypi.python.org/pypi/django-excel-response
           :alt: Latest Version
        
        .. image:: https://travis-ci.org/tarkatronic/django-excel-response.svg?branch=master
           :target: https://travis-ci.org/tarkatronic/django-excel-response
           :alt: Test/build status
        
        .. image:: https://codecov.io/gh/tarkatronic/django-excel-response/branch/master/graph/badge.svg
           :target: https://codecov.io/gh/tarkatronic/django-excel-response
           :alt: Code coverage
        
        
        A subclass of HttpResponse which will transform a QuerySet,
        or sequence of sequences, into either an Excel spreadsheet or
        CSV file formatted for Excel, depending on the amount of data.
        
        Installation
        ============
        
        ::
        
            pip install django-excel-response
        
        Provided Classes
        ================
        
        * ``excel_response.response.ExcelResponse``
        
            Accepted arguments:
        
            * ``data`` - A queryset or list of lists from which to construct the output
            * ``output_filename`` - The filename which should be suggested in the http response,
              minus the file extension (**default: excel_data**)
            * ``worksheet_name`` - The name of the worksheet inside the spreadsheet into which
              the data will be inserted (**default: None**)
            * ``force_csv`` - A boolean stating whether to force CSV output (**default: False**)
            * ``header_font`` - The font to be applied to the header row of the spreadsheet;
              must be an instance of ``openpyxl.styles.Font`` (**default: None**)
            * ``data_font`` - The font to be applied to all data cells in the spreadsheet;
              must be an instance of ``openpyxl.styles.Font`` (**default: None**)
        
        * ``excel_response.views.ExcelMixin``
        * ``excel_response.views.ExcelView``
        
        Examples
        ========
        
        Function-based views
        --------------------
        
        You can construct your data from a queryset.
        
        .. code-block:: python
        
            from excel_response import ExcelResponse
        
        
            def excelview(request):
                objs = SomeModel.objects.all()
                return ExcelResponse(objs)
        
        
        Or you can construct your data manually.
        
        .. code-block:: python
        
            from excel_response import ExcelResponse
        
        
            def excelview(request):
                data = [
                    ['Column 1', 'Column 2'],
                    [1,2]
                    [23,67]
                ]
                return ExcelResponse(data, 'my_data')
        
        Class-based views
        -----------------
        
        These are as simple as import and go!
        
        .. code-block:: python
        
            from excel_response import ExcelView
        
        
            class ModelExportView(ExcelView):
                model = SomeModel
Platform: UNKNOWN
Classifier: Development Status :: 5 - Production/Stable
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: Apache Software License
Classifier: Natural Language :: English
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python
Classifier: Programming Language :: Python :: 2.7
Classifier: Programming Language :: Python :: 3
Classifier: Programming Language :: Python :: 3.3
Classifier: Programming Language :: Python :: 3.4
Classifier: Programming Language :: Python :: 3.5
Classifier: Programming Language :: Python :: 3.6
Classifier: Framework :: Django
Classifier: Framework :: Django :: 1.8
Classifier: Framework :: Django :: 1.9
Classifier: Framework :: Django :: 1.10
Classifier: Framework :: Django :: 1.11
Classifier: Topic :: Software Development :: Libraries :: Python Modules
Classifier: Topic :: Office/Business :: Financial :: Spreadsheet
