Skip to main content

A django library to read, manipulate and write data in different excel formats: csv, ods, xls, xlsx and xlsm.

Project description

https://api.travis-ci.org/chfw/django-excel.svg?branch=v0.0.1 https://coveralls.io/repos/chfw/django-excel/badge.svg?branch=v0.0.1 https://readthedocs.org/projects/django-excel/badge/?version=v0.0.1 https://pypip.in/version/django-excel/badge.png https://pypip.in/d/django-excel/badge.png https://pypip.in/py_versions/django-excel/badge.png

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 Pythonic a list of lists, a list of records(dictionaries), dictionaries of lists. And vice versa. Hence it lets you focus on data in Django web development, instead of file formats.

The idea originated from the problem of the illiteracy of excel file formats of non-technical office workers: such as office assistant, human resource administrator. There is nothing with the un-deniable fact that some people do not know the difference among various excel formats. It becomes usability problem to those people when a web service cannot parse the excel file that they saved using Microsoft Excel. Instead of training those people about file formats, this library helps web developers to handle most of the excel file formats by unifying the programming interface to most of the excel readers and writers.

The highlighted features are:

  1. turn uploaded excel file directly into Python data struture

  2. pass Python data structures as an excel file download

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

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

Available Plugins

Plugins

Supported file formats

pyexcel-xls

xls, xlsx(r), xlsm(r)

pyexcel-xlsx

xlsx

pyexcel-ods

ods (python 2.6, 2.7)

pyexcel-ods3

ods (python 2.7, 3.3, 3.4)

pyexcel-text

(write only)json, rst, mediawiki,latex, grid, pipe, orgtbl, plain simple

Known constraints

Fonts, colors and charts are not supported.

Installation

You can install it via pip:

$ pip install django-excel

or clone it and install it:

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

Installation of individual plugins , please refer to individual plugin page.

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")

Dependencies

  • Django

  • pyexcel >= 0.1.3

  • pyexcel-webio

Project details


Download files

Download the file for your platform. If you're not sure which to choose, learn more about installing packages.

Source Distribution

django-excel-0.0.1.tar.gz (4.5 kB view hashes)

Uploaded Source

Supported by

AWS AWS Cloud computing and Security Sponsor Datadog Datadog Monitoring Fastly Fastly CDN Google Google Download Analytics Microsoft Microsoft PSF Sponsor Pingdom Pingdom Monitoring Sentry Sentry Error logging StatusPage StatusPage Status page