first commit

Author: chfw

.gitignore

@@ -0,0 +1,2 @@
+*.pyc
+*~

.travis.yml

@@ -0,0 +1,27 @@
+language: python
+notifications:
+  email: false
+env:
+  global:
+python:
+  - 2.6
+  - 2.7
+  - 3.3
+  - 3.4
+install:
+  - pip install git+https://github.com/chfw/pyexcel-io.git  
+  - pip install git+https://github.com/chfw/pyexcel.git
+  - pip install git+https://github.com/chfw/pyexcel-webio.git
+  - pip install git+https://github.com/chfw/pyexcel-xls.git
+  - pip install -r requirements.txt
+  - pip install -r test_requirements.txt --use-mirrors
+  - if [[ $TRAVIS_PYTHON_VERSION == "2.6" ]]; then pip install pyexcel-ods; fi
+  - if [[ $TRAVIS_PYTHON_VERSION == "2.7" ]]; then pip install pyexcel-ods; fi
+  - if [[ $TRAVIS_PYTHON_VERSION == "3.3" ]]; then pip install git+https://github.com/chfw/ezodf.git; fi
+  - if [[ $TRAVIS_PYTHON_VERSION == "3.4" ]]; then pip install git+https://github.com/chfw/ezodf.git; fi
+  - if [[ $TRAVIS_PYTHON_VERSION == "3.3" ]]; then pip install pyexcel-ods3; fi
+  - if [[ $TRAVIS_PYTHON_VERSION == "3.4" ]]; then pip install pyexcel-ods3; fi
+script:
+  make test
+after_success:
+  coveralls

README.rst

@@ -0,0 +1,81 @@
+==============================================================
+django-excel - Let you focus on data, instead of file formats
+==============================================================
+
+.. image:: https://api.travis-ci.org/chfw/django-excel.svg?branch=master
+    :target: http://travis-ci.org/chfw/django-excel
+
+.. image:: https://coveralls.io/repos/chfw/django-excel/badge.png?branch=master 
+    :target: https://coveralls.io/r/chfw/django-excel?branch=master 
+
+.. image:: https://readthedocs.org/projects/django-excel/badge/?version=latest
+    :target: http://django-excel.readthedocs.org/en/latest/
+
+.. image:: https://pypip.in/version/django-excel/badge.png
+    :target: https://pypi.python.org/pypi/django-excel
+
+.. image:: https://pypip.in/d/django-excel/badge.png
+    :target: https://pypi.python.org/pypi/django-excel
+
+.. image:: https://pypip.in/py_versions/django-excel/badge.png
+    :target: https://pypi.python.org/pypi/django-excel
+
+.. image:: http://img.shields.io/gittip/chfw.svg
+    :target: https://gratipay.com/chfw/
+
+**django-excel** is based on `pyexcel <https://github.com/chfw/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 Flask based 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:
+
+#. turn uploaded excel file directly into Python data struture
+#. pass Python data structures as an excel file download
+#. provide data persistence as an excel file in server side
+#. 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
+================ ========================================================================
+
+.. _pyexcel-xls: https://github.com/chfw/pyexcel-xls
+.. _pyexcel-xlsx: https://github.com/chfw/pyexcel-xlsx
+.. _pyexcel-ods: https://github.com/chfw/pyexcel-ods
+.. _pyexcel-ods3: https://github.com/chfw/pyexcel-ods3
+.. _pyexcel-text: https://github.com/chfw/pyexcel-text
+
+
+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.
+
+
+Dependencies
+=============
+
+* pyexcel

django_excel/__init__.py

@@ -0,0 +1,62 @@
+from django.core.files.uploadhandler import MemoryFileUploadHandler, TemporaryFileUploadHandler
+from django.core.files.uploadedfile import InMemoryUploadedFile, TemporaryUploadedFile
+from django.http import HttpResponse
+import pyexcel as pe
+import pyexcel_webio as webio
+
+
+class ExcelMemoryFile(webio.ExcelInput, InMemoryUploadedFile):
+    def _get_file_extension(self):
+        extension = self.name.split(".")[1]
+        return extension
+        
+    def load_single_sheet(self, sheet_name=None, **keywords):
+        return pe.load_from_memory(self._get_file_extension(), self.file.read(), sheet_name, **keywords)
+
+    def load_book(self):
+        return pe.load_book_from_memory(self._get_file_extension(), self.file.read())
+
+
+class ExcelFile(webio.ExcelInput, TemporaryUploadedFile):
+    def load_single_sheet(self, sheet_name=None, **keywords):
+        return pe.load(self.file.replace(".upload", ""), sheet_name, **keywords)
+
+    def load_book(self):
+        return pe.load_book(self.file.replace(".upload", ""))
+
+
+class ExcelMemoryFileUploadHandler(MemoryFileUploadHandler):
+    def file_complete(self, file_size):
+        self.file.seek(0)
+        return ExcelMemoryFile(
+            file=self.file,
+            field_name=self.field_name,
+            name=self.file_name,
+            content_type=self.content_type,
+            size=file_size,
+            charset=self.charset,
+            content_type_extra=self.content_type_extra
+        )
+
+class TemporaryExcelFileUploadHandler(TemporaryFileUploadHandler):
+    def file_complete(self, file_size):
+        self.file.seek(0)
+        return ExcelMemoryFile(
+            file=self.file,
+            field_name=self.field_name,
+            name=self.file_name,
+            content_type=self.content_type,
+            size=file_size,
+            charset=self.charset,
+            content_type_extra=self.content_type_extra
+        )
+
+webio.ExcelResponse = HttpResponse
+        
+from pyexcel_webio import (
+    make_response,
+    make_response_from_array,
+    make_response_from_dict,
+    make_response_from_records,
+    make_response_from_book_dict
+)

manage.py

@@ -0,0 +1,10 @@
+#!/usr/bin/env python
+import os
+import sys
+
+if __name__ == "__main__":
+    os.environ.setdefault("DJANGO_SETTINGS_MODULE", "mysite.settings")
+
+    from django.core.management import execute_from_command_line
+
+    execute_from_command_line(sys.argv)

mysite/__init__.py

@@ -0,0 +1,89 @@
+"""
+Django settings for mysite project.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/1.7/topics/settings/
+
+For the full list of settings and their values, see
+https://docs.djangoproject.com/en/1.7/ref/settings/
+"""
+
+# Build paths inside the project like this: os.path.join(BASE_DIR, ...)
+import os
+BASE_DIR = os.path.dirname(os.path.dirname(__file__))
+
+
+# Quick-start development settings - unsuitable for production
+# See https://docs.djangoproject.com/en/1.7/howto/deployment/checklist/
+
+# SECURITY WARNING: keep the secret key used in production secret!
+SECRET_KEY = '&kzg)(b_xt1*nyp-s97ibt01b7p+67#&-brmb_nqj&dn_%q6tc'
+
+# SECURITY WARNING: don't run with debug turned on in production!
+DEBUG = True
+
+TEMPLATE_DEBUG = True
+
+ALLOWED_HOSTS = []
+
+TEMPLATE_DIRS = [(
+    BASE_DIR + '/templates/'
+)]
+# Application definition
+
+FILE_UPLOAD_HANDLERS = ("django_excel.ExcelMemoryFileUploadHandler",
+                        "django_excel.TemporaryExcelFileUploadHandler")
+        
+INSTALLED_APPS = (
+    'django.contrib.admin',
+    'django.contrib.auth',
+    'django.contrib.contenttypes',
+    'django.contrib.sessions',
+    'django.contrib.messages',
+    'django.contrib.staticfiles',
+    'polls'
+)
+
+MIDDLEWARE_CLASSES = (
+    'django.contrib.sessions.middleware.SessionMiddleware',
+    'django.middleware.common.CommonMiddleware',
+    'django.middleware.csrf.CsrfViewMiddleware',
+    'django.contrib.auth.middleware.AuthenticationMiddleware',
+    'django.contrib.auth.middleware.SessionAuthenticationMiddleware',
+    'django.contrib.messages.middleware.MessageMiddleware',
+    'django.middleware.clickjacking.XFrameOptionsMiddleware',
+)
+
+ROOT_URLCONF = 'mysite.urls'
+
+WSGI_APPLICATION = 'mysite.wsgi.application'
+
+
+# Database
+# https://docs.djangoproject.com/en/1.7/ref/settings/#databases
+
+DATABASES = {
+    'default': {
+        'ENGINE': 'django.db.backends.sqlite3',
+        'NAME': os.path.join(BASE_DIR, 'db.sqlite3'),
+    }
+}
+
+# Internationalization
+# https://docs.djangoproject.com/en/1.7/topics/i18n/
+
+LANGUAGE_CODE = 'en-us'
+
+TIME_ZONE = 'UTC'
+
+USE_I18N = True
+
+USE_L10N = True
+
+USE_TZ = True
+
+
+# Static files (CSS, JavaScript, Images)
+# https://docs.djangoproject.com/en/1.7/howto/static-files/
+
+STATIC_URL = '/static/'

mysite/settings.py

@@ -0,0 +1,11 @@
+from django.conf.urls import patterns, include, url
+from django.contrib import admin
+
+urlpatterns = patterns('',
+    # Examples:
+    # url(r'^$', 'mysite.views.home', name='home'),
+    # url(r'^blog/', include('blog.urls')),
+
+    url(r'^admin/', include(admin.site.urls)),
+    url(r'^polls/', include('polls.urls'))
+)

mysite/urls.py

@@ -0,0 +1,14 @@
+"""
+WSGI config for mysite project.
+
+It exposes the WSGI callable as a module-level variable named ``application``.
+
+For more information on this file, see
+https://docs.djangoproject.com/en/1.7/howto/deployment/wsgi/
+"""
+
+import os
+os.environ.setdefault("DJANGO_SETTINGS_MODULE", "mysite.settings")
+
+from django.core.wsgi import get_wsgi_application
+application = get_wsgi_application()

mysite/wsgi.py

@@ -0,0 +1,3 @@
+from django.contrib import admin
+
+# Register your models here.

polls/__init__.py

@@ -0,0 +1,3 @@
+from django.db import models
+
+# Create your models here.

polls/admin.py

@@ -0,0 +1,3 @@
+from django.test import TestCase
+
+# Create your tests here.

polls/models.py

@@ -0,0 +1,11 @@
+from django.conf.urls import patterns, url
+
+from polls import views
+
+urlpatterns = patterns(
+    '',
+    url(r'^$', views.upload, name='uplink'),
+    url(r'^download/(.*)', views.download, name="download"),
+    url(r'^exchange/(.*)', views.exchange, name="exchange"),
+    url(r'^parse/(.*)', views.parse, name="parse")
+)

polls/tests.py

@@ -0,0 +1,61 @@
+from django.shortcuts import render_to_response
+from django.http import HttpResponse, HttpResponseBadRequest, JsonResponse
+from django import forms
+from django.template import RequestContext
+import django_excel as excel
+import pyexcel.ext.xls
+import pyexcel.ext.xlsx
+import pyexcel.ext.ods
+
+data = [
+    [1, 2, 3],
+    [4, 5, 6]
+]
+
+class UploadFileForm(forms.Form):
+    file = forms.FileField()
+
+
+# Create your views here.
+def upload(request):
+    if request.method == "POST":
+        import pdb; pdb.set_trace()
+        form = UploadFileForm(request.POST, request.FILES)
+        if form.is_valid():
+            filehandle = request.FILES['file']
+            return excel.make_response(filehandle.get_sheet(), "csv")
+    else:
+        form = UploadFileForm()
+    return render_to_response('upload_form.html', {'form': form}, context_instance=RequestContext(request))
+
+def download(request, file_type):
+    sheet = excel.pe.Sheet(data)
+    return excel.make_response(sheet, file_type)
+
+def exchange(request, file_type):
+    form = UploadFileForm(request.POST, request.FILES)
+    if form.is_valid():
+        filehandle = request.FILES['file']
+        return excel.make_response(filehandle.get_sheet(), file_type)
+    else:
+        return HttpResponseBadRequest()
+
+def parse(request, data_struct_type):
+    form = UploadFileForm(request.POST, request.FILES)
+    if form.is_valid():
+        filehandle = request.FILES['file']
+        if data_struct_type == "array":
+            return JsonResponse({"result":filehandle.get_array()})
+        elif data_struct_type == "dict":
+            return JsonResponse(filehandle.get_dict())
+        elif data_struct_type == "records":
+            return JsonResponse({"result":filehandle.get_records()})
+        elif data_struct_type == "book":
+            return JsonResponse(filehandle.get_book().to_dict())
+        elif data_struct_type == "book_dict":
+            return JsonResponse(filehandle.get_book_dict())
+        else:
+            return HttpResponseBadRequest()
+    else:
+        return HttpResponseBadRequest()
+

polls/urls.py

@@ -0,0 +1,3 @@
+pyexcel>=0.1.2
+pyexcel-webio>=0.0.1
+Django==1.7.1