django-excel 0.0.5

A django middleware that provides one application programming interface to read and write data in different excel file formats

Here is a typical conversation between the developer and the user:

User: "I have uploaded an excel file"
      "but your application says un-supported file format"
Developer: "Did you upload an xlsx file or a csv file?"
User: "Well, I am not sure. I saved the data using "
      "Microsoft Excel. Surely, it must be in an excel format."
Developer: "OK. Here is the thing. I were not told to support"
           "all available excel formats in day 1. Live with it"
           "or delay the project x number of days."

django-excel is based on pyexcel and makes it easy to consume/produce information stored in excel files over HTTP protocol as well as on file system. This library can turn the excel data into a list of lists, a list of records(dictionaries), dictionaries of lists. And vice versa. Hence it lets you focus on data in Django based web development, instead of file formats.

The idea originated from the common usability problem when developing an excel file driven web applications for non-technical office workers: such as office assistant, human resource administrator. The fact is that not all people know the difference among various excel formats: csv, xls, xlsx. Instead of training those people about file formats, this library helps web developers to handle most of the excel file formats by providing a common programming interface. To add a specific excel file format to you application, all you need is to install an extra pyexcel plugin. No code change to your application.

The highlighted features are:

1. excel data import into and export from databases

2. turn uploaded excel file directly into Python data structure

3. pass Python data structures as an excel file download

4. provide data persistence as an excel file in server side

5. supports csv, tsv, csvz, tsvz by default and other formats are supported via the following plugins:

A list of file formats supported by external plugins

Plugins	Supported file formats
pyexcel-xls	xls, xlsx(r), xlsm(r)
pyexcel-xlsx	xlsx
pyexcel-ods3	ods (python 2.6, 2.7, 3.3, 3.4)
pyexcel-ods	ods (python 2.6, 2.7)
pyexcel-text	(write only)json, rst, mediawiki, html latex, grid, pipe, orgtbl, plain simple

This library makes information processing involving various excel files as easy as processing array, dictionary when processing file upload/download, data import into and export from SQL databases, information analysis and persistence. It uses pyexcel and its plugins:

1. to provide one uniform programming interface to handle csv, tsv, xls, xlsx, xlsm and ods formats.

2. to provide one-stop utility to import the data in uploaded file into a database and to export tables in a database as excel files for file download.

3. to provide the same interface for information persistence at server side: saving a uploaded excel file to and loading a saved excel file from file system.

Known constraints

Fonts, colors and charts are not supported.

Tested Django Versions

Installation

Recently, pyexcel(0.2.2+) and its plugins(0.2.0+) started using newer version of setuptools. Please upgrade your setup tools before install latest pyexcel components:

$ pip install --upgrade setuptools

You can install it via pip:

$ pip install django-excel

or clone it and install it:

$ git clone http://github.com/pyexcel/django-excel.git
$ cd django-excel
$ python setup.py install

Setup

You will need to update your settings.py:

FILE_UPLOAD_HANDLERS = ("django_excel.ExcelMemoryFileUploadHandler",
                        "django_excel.TemporaryExcelFileUploadHandler")

Usage

Here is the example viewing function codes:

from django.shortcuts import render_to_response
from django.http import HttpResponseBadRequest
from django import forms
from django.template import RequestContext
import django_excel as excel

class UploadFileForm(forms.Form):
    file = forms.FileField()

def upload(request):
    if request.method == "POST":
        form = UploadFileForm(request.POST, request.FILES)
        if form.is_valid():
            filehandle = request.FILES['file']
            return excel.make_response(filehandle.get_sheet(), "csv")
        else:
            return HttpResponseBadRequest()
    else:
        form = UploadFileForm()
    return render_to_response('upload_form.html',
                              {'form': form},
                              context_instance=RequestContext(request))

def download(request):
    sheet = excel.pe.Sheet([[1, 2],[3, 4]])
    return excel.make_response(sheet, "csv")

License

New BSD License

Change log

0.0.5 - 26.08.2016

Added:

1. Support for django 1.6.x

2. Tested against django 1.10