https://github.com/tarkatronic/django-excel-response

Django package to easily render Excel spreadsheets
https://github.com/tarkatronic/django-excel-response

csv django excel

Last synced: about 1 month ago
JSON representation

Django package to easily render Excel spreadsheets

• Host: GitHub
• URL: https://github.com/tarkatronic/django-excel-response
• Owner: tarkatronic
• License: apache-2.0
• Archived: true
• Created: 2017-04-26T17:15:43.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2024-01-25T18:52:23.000Z (10 months ago)
• Last Synced: 2024-09-26T00:54:11.879Z (about 2 months ago)
• Topics: csv, django, excel
• Language: Python
• Size: 55.7 KB
• Stars: 81
• Watchers: 9
• Forks: 26
• Open Issues: 12
• Metadata Files:
  • Readme: README.rst
  • Changelog: CHANGELOG
  • License: LICENSE

Awesome Lists containing this project

README

        
.. image:: http://unmaintained.tech/badge.svg

  :target: http://unmaintained.tech

  :alt: No Maintenance Intended

=====================

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